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 "pbd/signals.h"
  27
  28 #include <gtkmm/textview.h>
  29
  30 #include "gtkmm2ext/widget_state.h"
  31
  32 #include "ardour/ardour.h"
  33 #include "ardour/mute_master.h"
  34 #include "ardour/session_event.h"
  35 #include "ardour/session.h"
  36 #include "ardour/route.h"
  37 #include "ardour/route_group.h"
  38 #include "ardour/track.h"
  39
  40 #include "axis_view.h"
  41 #include "selectable.h"
  42 #include "window_manager.h"
  43
  44 namespace ARDOUR {
  45         class AudioTrack;
  46         class MidiTrack;
  47 }
  48
  49 namespace Gtk {
  50         class Menu;
  51         class CheckMenuItem;
  52         class Widget;
  53 }
  54
  55 class ArdourButton;
  56 class ArdourWindow;
  57 class IOSelectorWindow;
  58
  59 class RoutePinWindowProxy : public WM::ProxyBase
  60 {
  61   public:
  62         RoutePinWindowProxy (std::string const &, boost::shared_ptr<ARDOUR::Route>);
  63         ~RoutePinWindowProxy();
  64
  65         Gtk::Window* get (bool create = false);
  66         ARDOUR::SessionHandlePtr* session_handle();
  67
  68   private:
  69         boost::weak_ptr<ARDOUR::Route> _route;
  70
  71         void route_going_away ();
  72         PBD::ScopedConnection going_away_connection;
  73 };
  74
  75 class RouteUI : public virtual AxisView
  76 {
  77   public:
  78         RouteUI(ARDOUR::Session*);
  79         RouteUI(boost::shared_ptr<ARDOUR::Route>, ARDOUR::Session*);
  80
  81         virtual ~RouteUI();
  82
  83         Gdk::Color color () const;
  84
  85         virtual void set_route (boost::shared_ptr<ARDOUR::Route>);
  86         virtual void set_button_names () = 0;
  87
  88         bool is_track() const;
  89         bool is_audio_track() const;
  90         bool is_midi_track() const;
  91         bool has_audio_outputs () const;
  92
  93         boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
  94         ARDOUR::RouteGroup* route_group() const;
  95
  96         boost::shared_ptr<ARDOUR::Track>      track() const;
  97         boost::shared_ptr<ARDOUR::AudioTrack> audio_track() const;
  98         boost::shared_ptr<ARDOUR::MidiTrack>  midi_track() const;
  99
 100         std::string name() const;
 101
 102         // protected: XXX sigh this should be here
 103
 104         boost::shared_ptr<ARDOUR::Route> _route;
 105
 106         void request_redraw ();
 107
 108         virtual void set_color (uint32_t c);
 109         Gdk::Color route_color () const;
 110         void choose_color ();
 111
 112         bool ignore_toggle;
 113         bool wait_for_release;
 114         bool multiple_mute_change;
 115         bool multiple_solo_change;
 116
 117         Gtk::HBox _invert_button_box;
 118         ArdourButton* mute_button;
 119         ArdourButton* solo_button;
 120         ArdourButton* rec_enable_button; /* audio tracks */
 121         ArdourButton* show_sends_button; /* busses */
 122         ArdourButton* monitor_input_button;
 123         ArdourButton* monitor_disk_button;
 124
 125         Glib::RefPtr<Gdk::Pixbuf> solo_safe_pixbuf;
 126
 127         ArdourButton* solo_safe_led;
 128         ArdourButton* solo_isolated_led;
 129
 130         ArdourButton* vca_button;
 131
 132         Gtk::Label monitor_input_button_label;
 133         Gtk::Label monitor_disk_button_label;
 134
 135         void send_blink (bool);
 136         sigc::connection send_blink_connection;
 137
 138         sigc::connection rec_blink_connection;
 139
 140         Gtk::Menu* mute_menu;
 141         Gtk::Menu* solo_menu;
 142         Gtk::Menu* sends_menu;
 143
 144         boost::shared_ptr<ARDOUR::Delivery> _current_delivery;
 145
 146         bool mute_press(GdkEventButton*);
 147         bool mute_release(GdkEventButton*);
 148         bool solo_press(GdkEventButton*);
 149         bool solo_release(GdkEventButton*);
 150         bool rec_enable_press(GdkEventButton*);
 151         bool rec_enable_release(GdkEventButton*);
 152         bool show_sends_press(GdkEventButton*);
 153         bool show_sends_release(GdkEventButton*);
 154
 155         bool monitor_release(GdkEventButton*, ARDOUR::MonitorChoice);
 156         bool monitor_input_press(GdkEventButton*);
 157         bool monitor_input_release(GdkEventButton*);
 158         bool monitor_disk_press(GdkEventButton*);
 159         bool monitor_disk_release(GdkEventButton*);
 160         void update_monitoring_display ();
 161
 162         void edit_input_configuration ();
 163         void edit_output_configuration ();
 164
 165         void step_gain_up ();
 166         void step_gain_down ();
 167         void page_gain_up ();
 168         void page_gain_down ();
 169
 170         void build_sends_menu ();
 171         void set_sends_gain_from_track ();
 172         void set_sends_gain_to_zero ();
 173         void set_sends_gain_to_unity ();
 174         void create_sends (ARDOUR::Placement, bool);
 175         void create_selected_sends (ARDOUR::Placement, bool);
 176
 177         void solo_changed(bool, void*);
 178         void solo_changed_so_update_mute ();
 179         void listen_changed(void*);
 180         virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
 181         void route_rec_enable_changed();
 182         void session_rec_enable_changed();
 183
 184         void build_solo_menu ();
 185
 186         void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
 187         void toggle_solo_isolated (Gtk::CheckMenuItem*);
 188
 189         bool solo_isolate_button_release (GdkEventButton*);
 190         bool solo_safe_button_release (GdkEventButton*);
 191
 192         void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
 193         void toggle_solo_safe (Gtk::CheckMenuItem*);
 194
 195         Gtk::CheckMenuItem* pre_fader_mute_check;
 196         Gtk::CheckMenuItem* post_fader_mute_check;
 197         Gtk::CheckMenuItem* listen_mute_check;
 198         Gtk::CheckMenuItem* main_mute_check;
 199         Gtk::CheckMenuItem* solo_safe_check;
 200         Gtk::CheckMenuItem* solo_isolated_check;
 201
 202         void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
 203         void muting_change ();
 204         void build_mute_menu(void);
 205         void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
 206
 207         int  set_color_from_route ();
 208
 209         void route_rename();
 210
 211         void manage_pins ();
 212         void maybe_add_route_print_mgr ();
 213
 214         virtual void property_changed (const PBD::PropertyChange&);
 215         void route_removed ();
 216
 217         virtual void route_active_changed () {}
 218         void set_route_active (bool, bool);
 219         void duplicate_selected_routes ();
 220
 221         Gtk::Menu* record_menu;
 222         void build_record_menu ();
 223
 224         Gtk::CheckMenuItem *step_edit_item;
 225         void toggle_step_edit ();
 226         virtual void step_edit_changed (bool);
 227
 228         Gtk::CheckMenuItem *rec_safe_item;
 229         void toggle_rec_safe ();
 230
 231         virtual void polarity_changed ();
 232
 233         Gtk::CheckMenuItem *denormal_menu_item;
 234         void toggle_denormal_protection();
 235         virtual void denormal_protection_changed ();
 236
 237         void disconnect_input ();
 238         void disconnect_output ();
 239
 240         virtual void blink_rec_display (bool onoff);
 241         void update_mute_display ();
 242
 243         void update_solo_display ();
 244
 245         void update_vca_display ();
 246
 247         virtual void map_frozen ();
 248
 249         void adjust_latency ();
 250         bool process_save_template_prompter (ArdourPrompter& prompter, const std::string& dir);
 251         void save_as_template ();
 252
 253         static Gtkmm2ext::ActiveState solo_active_state (boost::shared_ptr<ARDOUR::Stripable>);
 254         static Gtkmm2ext::ActiveState solo_isolate_active_state (boost::shared_ptr<ARDOUR::Stripable>);
 255         static Gtkmm2ext::ActiveState solo_safe_active_state (boost::shared_ptr<ARDOUR::Stripable>);
 256         static Gtkmm2ext::ActiveState mute_active_state (ARDOUR::Session*, boost::shared_ptr<ARDOUR::Stripable>);
 257
 258         /** Emitted when a bus has been set or unset from `display sends to this bus' mode
 259          *  by a click on the `Sends' button.  The parameter is the route that the sends are
 260          *  to, or 0 if no route is now in this mode.
 261          */
 262         static PBD::Signal1<void, boost::shared_ptr<ARDOUR::Route> > BusSendDisplayChanged;
 263
 264         void comment_editor_done_editing ();
 265         void setup_comment_editor ();
 266         void open_comment_editor ();
 267         void toggle_comment_editor ();
 268
 269         gint comment_key_release_handler (GdkEventKey*);
 270         void comment_changed ();
 271         void comment_edited ();
 272         bool ignore_comment_edit;
 273
 274    protected:
 275
 276         ArdourWindow*  comment_window;
 277         Gtk::TextView* comment_area;
 278         IOSelectorWindow *input_selector;
 279         IOSelectorWindow *output_selector;
 280
 281         PBD::ScopedConnectionList route_connections;
 282         bool self_destruct;
 283
 284         void init ();
 285         void reset ();
 286
 287         void self_delete ();
 288         virtual void start_step_editing () {}
 289         virtual void stop_step_editing() {}
 290
 291         void set_invert_sensitive (bool);
 292         bool verify_new_route_name (const std::string& name);
 293
 294         void route_gui_changed (std::string);
 295         virtual void route_color_changed () {}
 296
 297         void check_rec_enable_sensitivity ();
 298
 299         virtual void bus_send_display_changed (boost::shared_ptr<ARDOUR::Route>);
 300
 301         static std::string program_port_prefix;
 302
 303         bool mark_hidden (bool yn);
 304
 305   private:
 306         void parameter_changed (std::string const &);
 307         void relabel_solo_button ();
 308         void track_mode_changed ();
 309
 310         std::string route_state_id () const;
 311
 312 protected:
 313         struct SoloMuteRelease {
 314             SoloMuteRelease (bool was_active)
 315             : active (was_active)
 316             , exclusive (false) {}
 317
 318             boost::shared_ptr<ARDOUR::RouteList> routes;
 319             boost::shared_ptr<ARDOUR::RouteList> routes_on;
 320             boost::shared_ptr<ARDOUR::RouteList> routes_off;
 321             boost::shared_ptr<ARDOUR::Route> route;
 322             bool active;
 323             bool exclusive;
 324         };
 325
 326         SoloMuteRelease* _solo_release;
 327         SoloMuteRelease* _mute_release;
 328
 329 private:
 330         void setup_invert_buttons ();
 331         void set_invert_button_state ();
 332         void invert_menu_toggled (uint32_t);
 333         bool invert_press (GdkEventButton *);
 334         bool invert_release (GdkEventButton *, uint32_t i);
 335
 336         int _i_am_the_modifier;
 337         std::vector<ArdourButton*> _invert_buttons;
 338         Gtk::Menu* _invert_menu;
 339
 340         static void set_showing_sends_to (boost::shared_ptr<ARDOUR::Route>);
 341         static boost::weak_ptr<ARDOUR::Route> _showing_sends_to;
 342
 343         static uint32_t _max_invert_buttons;
 344 };
 345
 346 #endif /* __ardour_route_ui__ */