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