gtk2_ardour/ardour_ui.h

   1 /*
   2     Copyright (C) 1999-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     $Id$
  19 */
  20
  21 #ifndef __ardour_gui_h__
  22 #define __ardour_gui_h__
  23
  24 /* need _BSD_SOURCE to get timersub macros */
  25
  26 #ifdef _BSD_SOURCE
  27 #include <sys/time.h>
  28 #else
  29 #define _BSD_SOURCE
  30 #include <sys/time.h>
  31 #undef _BSD_SOURCE
  32 #endif
  33
  34 #include <list>
  35
  36 #include <cmath>
  37
  38 #include <libgnomecanvasmm/canvas.h>
  39
  40 #include <pbd/xml++.h>
  41 #include <gtkmm/box.h>
  42 #include <gtkmm/frame.h>
  43 #include <gtkmm/label.h>
  44 #include <gtkmm/table.h>
  45 #include <gtkmm/fixed.h>
  46 #include <gtkmm/drawingarea.h>
  47 #include <gtkmm/eventbox.h>
  48 #include <gtkmm/menu.h>
  49 #include <gtkmm/menuitem.h>
  50 #include <gtkmm/button.h>
  51 #include <gtkmm/togglebutton.h>
  52 #include <gtkmm/treeview.h>
  53 #include <gtkmm/menubar.h>
  54 #include <gtkmm/adjustment.h>
  55 #include <gtkmm2ext/gtk_ui.h>
  56 #include <gtkmm2ext/click_box.h>
  57 #include <gtkmm2ext/stateful_button.h>
  58 #include <ardour/ardour.h>
  59 #include <ardour/session.h>
  60
  61 #include "audio_clock.h"
  62 #include "ardour_dialog.h"
  63 #include "editing.h"
  64
  65 class AudioClock;
  66 class PublicEditor;
  67 class Keyboard;
  68 class MeterBridge;
  69 class OptionEditor;
  70 class Mixer_UI;
  71 class ConnectionEditor;
  72 class RouteParams_UI;
  73 class About;
  74 class AddRouteDialog;
  75 class NewSessionDialog;
  76 class LocationUI;
  77 class ColorManager;
  78
  79 namespace Gtkmm2ext {
  80         class TearOff;
  81 }
  82
  83 namespace ARDOUR {
  84         class AudioEngine;
  85         class Route;
  86         class Port;
  87         class IO;
  88         class ControlProtocolInfo;
  89 }
  90
  91 namespace ALSA {
  92         class MultiChannelDevice;
  93 }
  94
  95 #define FRAME_NAME "BaseFrame"
  96
  97 class ARDOUR_UI : public Gtkmm2ext::UI
  98 {
  99   public:
 100         ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
 101         ~ARDOUR_UI();
 102
 103         void show ();
 104         bool shown() { return shown_flag; }
 105
 106         void show_splash ();
 107         void hide_splash ();
 108
 109         int load_session (const string & path, const string & snapshot, string* mix_template = 0);
 110         bool session_loaded;
 111         int build_session (const string & path, const string & snapshot,
 112                            uint32_t ctl_chns,
 113                            uint32_t master_chns,
 114                            ARDOUR::AutoConnectOption input_connect,
 115                            ARDOUR::AutoConnectOption output_connect,
 116                            uint32_t nphysin,
 117                            uint32_t nphysout,
 118                            nframes_t initial_length);
 119         bool session_is_new() const { return _session_is_new; }
 120
 121         ARDOUR::Session* the_session() { return session; }
 122
 123         bool will_create_new_session_automatically() const {
 124                 return _will_create_new_session_automatically;
 125         }
 126
 127         void set_will_create_new_session_automatically (bool yn) {
 128                 _will_create_new_session_automatically = yn;
 129         }
 130
 131         void new_session(bool startup = false, std::string path = string());
 132         gint cmdline_new_session (string path);
 133         int  unload_session ();
 134         void close_session();
 135
 136         int  save_state_canfail (string state_name = "");
 137         void save_state (const string & state_name = "");
 138         void restore_state (string state_name = "");
 139
 140         static double gain_to_slider_position (ARDOUR::gain_t g);
 141         static ARDOUR::gain_t slider_position_to_gain (double pos);
 142
 143         static ARDOUR_UI *instance () { return theArdourUI; }
 144
 145         PublicEditor&     the_editor(){return *editor;}
 146         Mixer_UI* the_mixer() { return mixer; }
 147
 148         void toggle_location_window ();
 149         void toggle_color_manager ();
 150         void toggle_big_clock_window ();
 151         void toggle_connection_editor ();
 152         void toggle_route_params_window ();
 153         void toggle_editing_space();
 154
 155         Gtk::Tooltips& tooltips() { return _tooltips; }
 156
 157         static sigc::signal<void,bool> Blink;
 158         static sigc::signal<void>      RapidScreenUpdate;
 159         static sigc::signal<void>      SuperRapidScreenUpdate;
 160         static sigc::signal<void,nframes_t> Clock;
 161
 162         /* this is a helper function to centralize the (complex) logic for
 163            blinking rec-enable buttons.
 164         */
 165
 166         void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
 167
 168         void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
 169
 170         static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
 171
 172         XMLNode* editor_settings() const;
 173         XMLNode* mixer_settings () const;
 174         XMLNode* keyboard_settings () const;
 175
 176         void save_ardour_state ();
 177         gboolean configure_handler (GdkEventConfigure* conf);
 178
 179         void do_transport_locate (nframes_t position);
 180         void halt_on_xrun_message ();
 181
 182         AudioClock primary_clock;
 183         AudioClock secondary_clock;
 184         AudioClock preroll_clock;
 185         AudioClock postroll_clock;
 186
 187         void add_route ();
 188
 189         void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
 190                 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
 191         }
 192
 193         void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
 194                 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
 195         }
 196
 197         void session_add_midi_track ();
 198
 199         void set_engine (ARDOUR::AudioEngine&);
 200         gint start_engine ();
 201
 202         gint exit_on_main_window_close (GdkEventAny *);
 203
 204         void maximise_editing_space ();
 205         void restore_editing_space ();
 206
 207         void set_native_file_header_format (ARDOUR::HeaderFormat sf);
 208         void set_native_file_data_format (ARDOUR::SampleFormat sf);
 209
 210         void set_keybindings_path (std::string path);
 211         void save_keybindings ();
 212
 213   protected:
 214         friend class PublicEditor;
 215
 216         void toggle_clocking ();
 217         void toggle_auto_play ();
 218         void toggle_auto_input ();
 219         void toggle_punch_in ();
 220         void toggle_punch_out ();
 221         void toggle_auto_return ();
 222         void toggle_click ();
 223
 224         void toggle_session_auto_loop ();
 225
 226         void toggle_options_window ();
 227
 228   private:
 229         struct GlobalClickBox : public Gtk::VBox {
 230             Gtkmm2ext::ClickBox  *box;
 231             Gtk::Frame      frame;
 232             Gtk::Label      label;
 233             vector<string> &strings;
 234             Gtk::Adjustment adjustment;
 235
 236             static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
 237
 238             GlobalClickBox (const string &str, vector<string> &vs)
 239                     : strings (vs),
 240                       adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
 241                     box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
 242                     label.set_text (str);
 243                     label.set_name ("GlobalButtonLabel");
 244                     frame.add (*box);
 245                     frame.set_shadow_type (Gtk::SHADOW_IN);
 246                     pack_start (label);
 247                     pack_start (frame);
 248                     box->set_print_func (printer, this);
 249                     box->set_wrap (true);
 250             };
 251         };
 252
 253         ARDOUR::AudioEngine                 *engine;
 254         ARDOUR::Session                     *session;
 255
 256         Gtk::Tooltips          _tooltips;
 257
 258         void                     goto_editor_window ();
 259         void                     goto_mixer_window ();
 260
 261         Gtk::Table               adjuster_table;
 262         Gtk::Frame               adjuster_frame;
 263         Gtk::Fixed               adjuster_base;
 264
 265         GlobalClickBox     *online_control_button;
 266         vector<string>      online_control_strings;
 267
 268         GlobalClickBox    *crossfade_time_button;
 269         vector<string>     crossfade_time_strings;
 270
 271         GlobalClickBox    *mmc_id_button;
 272         vector<string>     mmc_id_strings;
 273
 274         Gtk::ToggleButton   preroll_button;
 275         Gtk::ToggleButton   postroll_button;
 276
 277         Gtk::Table          transport_table;
 278         Gtk::Table          option_table;
 279
 280         int  setup_windows ();
 281         void setup_transport ();
 282         void setup_clock ();
 283         void setup_adjustables ();
 284
 285         static ARDOUR_UI *theArdourUI;
 286
 287         void startup ();
 288         void shutdown ();
 289
 290         void finish();
 291         int  ask_about_saving_session (const string & why);
 292         int  save_the_session;
 293
 294         void queue_transport_change ();
 295         void map_transport_state ();
 296         int32_t do_engine_start ();
 297
 298         void engine_halted ();
 299         void engine_stopped ();
 300         void engine_running ();
 301
 302         void use_config ();
 303
 304         static gint _blink  (void *);
 305         void blink ();
 306         gint blink_timeout_tag;
 307         bool blink_on;
 308         void start_blinking ();
 309         void stop_blinking ();
 310
 311         void control_methods_adjusted ();
 312         void mmc_device_id_adjusted ();
 313
 314         void about_signal_response(int response);
 315
 316   private:
 317         Gtk::VBox     top_packer;
 318
 319         sigc::connection clock_signal_connection;
 320         void         update_clocks ();
 321         void         start_clocking ();
 322         void         stop_clocking ();
 323
 324         void manage_window (Gtk::Window&);
 325
 326         AudioClock   big_clock;
 327         Gtk::Frame   big_clock_frame;
 328         Gtk::Window* big_clock_window;
 329
 330         void update_transport_clocks (nframes_t pos);
 331         void record_state_changed ();
 332
 333         /* Transport Control */
 334
 335         void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
 336         void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
 337
 338         Gtkmm2ext::TearOff*      transport_tearoff;
 339         Gtk::Frame               transport_frame;
 340         Gtk::HBox                transport_tearoff_hbox;
 341         Gtk::HBox                transport_hbox;
 342         Gtk::Fixed               transport_base;
 343         Gtk::Fixed               transport_button_base;
 344         Gtk::Frame               transport_button_frame;
 345         Gtk::HBox                transport_button_hbox;
 346         Gtk::VBox                transport_button_vbox;
 347         Gtk::HBox                transport_option_button_hbox;
 348         Gtk::VBox                transport_option_button_vbox;
 349         Gtk::HBox                transport_clock_hbox;
 350         Gtk::VBox                transport_clock_vbox;
 351         Gtk::HBox                primary_clock_hbox;
 352         Gtk::HBox                secondary_clock_hbox;
 353
 354         Gtkmm2ext::StatefulButton roll_button;
 355         Gtkmm2ext::StatefulButton stop_button;
 356         Gtkmm2ext::StatefulButton rewind_button;
 357         Gtkmm2ext::StatefulButton forward_button;
 358         Gtkmm2ext::StatefulButton goto_start_button;
 359         Gtkmm2ext::StatefulButton goto_end_button;
 360         Gtkmm2ext::StatefulButton auto_loop_button;
 361         Gtkmm2ext::StatefulButton play_selection_button;
 362
 363         Gtkmm2ext::StatefulButton rec_button;
 364
 365         Gtk::ToggleButton time_master_button;
 366         Gtk::ComboBoxText sync_option_combo;
 367
 368         void sync_option_changed ();
 369         void toggle_time_master ();
 370         void toggle_video_sync ();
 371
 372         Gtk::DrawingArea  shuttle_box;
 373         Gtk::EventBox     speed_display_box;
 374         Gtk::Label        speed_display_label;
 375         Gtk::Button       shuttle_units_button;
 376         Gtk::ComboBoxText shuttle_style_button;
 377         Gtk::Menu*        shuttle_unit_menu;
 378         Gtk::Menu*        shuttle_style_menu;
 379         float             shuttle_max_speed;
 380         Gtk::Menu*        shuttle_context_menu;
 381
 382         void build_shuttle_context_menu ();
 383         void show_shuttle_context_menu ();
 384         void shuttle_style_changed();
 385         void shuttle_unit_clicked ();
 386         void set_shuttle_max_speed (float);
 387         void update_speed_display ();
 388         float last_speed_displayed;
 389
 390         gint shuttle_box_button_press (GdkEventButton*);
 391         gint shuttle_box_button_release (GdkEventButton*);
 392         gint shuttle_box_scroll (GdkEventScroll*);
 393         gint shuttle_box_motion (GdkEventMotion*);
 394         gint shuttle_box_expose (GdkEventExpose*);
 395         gint mouse_shuttle (double x, bool force);
 396         void use_shuttle_fract (bool force);
 397
 398         bool   shuttle_grabbed;
 399         double shuttle_fract;
 400
 401         Gtk::ToggleButton punch_in_button;
 402         Gtk::ToggleButton punch_out_button;
 403         Gtk::ToggleButton auto_return_button;
 404         Gtk::ToggleButton auto_play_button;
 405         Gtk::ToggleButton auto_input_button;
 406         Gtk::ToggleButton click_button;
 407         Gtk::ToggleButton auditioning_alert_button;
 408         Gtk::ToggleButton solo_alert_button;
 409
 410         Gtk::VBox alert_box;
 411
 412         void solo_blink (bool);
 413         void audition_blink (bool);
 414
 415         void soloing_changed (bool);
 416         void auditioning_changed (bool);
 417         void _auditioning_changed (bool);
 418
 419         void solo_alert_toggle ();
 420         void audition_alert_toggle ();
 421
 422         void primary_clock_value_changed ();
 423         void secondary_clock_value_changed ();
 424
 425         /* called by Blink signal */
 426
 427         void transport_rec_enable_blink (bool onoff);
 428
 429         /* These change where we accept control from:
 430            MMC, X (local) or both.
 431         */
 432
 433         void allow_mmc_only ();
 434         void allow_mmc_and_local ();
 435         void allow_local_only ();
 436
 437         Gtk::Menu*        session_popup_menu;
 438
 439         struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
 440             RecentSessionModelColumns() {
 441                     add (visible_name);
 442                     add (fullpath);
 443             }
 444             Gtk::TreeModelColumn<Glib::ustring> visible_name;
 445             Gtk::TreeModelColumn<Glib::ustring> fullpath;
 446         };
 447
 448         RecentSessionModelColumns    recent_session_columns;
 449         Gtk::TreeView                recent_session_display;
 450         Glib::RefPtr<Gtk::TreeStore> recent_session_model;
 451
 452         ArdourDialog*     session_selector_window;
 453         Gtk::FileChooserDialog* open_session_selector;
 454
 455         void build_session_selector();
 456         void redisplay_recent_sessions();
 457         void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
 458
 459         struct RecentSessionsSorter {
 460             bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
 461                     return cmp_nocase(a.first, b.first) == -1;
 462             }
 463         };
 464
 465         /* menu bar and associated stuff */
 466
 467         Gtk::MenuBar* menu_bar;
 468         Gtk::EventBox menu_bar_base;
 469         Gtk::HBox     menu_hbox;
 470
 471         void build_menu_bar ();
 472         void build_control_surface_menu ();
 473
 474         Gtk::Label   wall_clock_label;
 475         Gtk::EventBox wall_clock_box;
 476         gint update_wall_clock ();
 477
 478         Gtk::Label   disk_space_label;
 479         Gtk::EventBox disk_space_box;
 480         void update_disk_space ();
 481
 482         Gtk::Label   cpu_load_label;
 483         Gtk::EventBox cpu_load_box;
 484         void update_cpu_load ();
 485
 486         Gtk::Label   buffer_load_label;
 487         Gtk::EventBox buffer_load_box;
 488         void update_buffer_load ();
 489
 490         Gtk::Label   sample_rate_label;
 491         Gtk::EventBox sample_rate_box;
 492         void update_sample_rate (nframes_t);
 493
 494         gint every_second ();
 495         gint every_point_one_seconds ();
 496         gint every_point_zero_one_seconds ();
 497
 498         sigc::connection second_connection;
 499         sigc::connection point_one_second_connection;
 500         sigc::connection point_zero_one_second_connection;
 501
 502         gint session_menu (GdkEventButton *);
 503
 504         bool _will_create_new_session_automatically;
 505
 506         NewSessionDialog* new_session_dialog;
 507
 508         void open_session ();
 509         void open_recent_session ();
 510         void save_template ();
 511
 512         void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
 513
 514         void set_transport_sensitivity (bool);
 515
 516         void remove_last_capture ();
 517
 518         void transport_goto_zero ();
 519         void transport_goto_start ();
 520         void transport_goto_end ();
 521         void transport_stop ();
 522         void transport_stop_and_forget_capture ();
 523         void transport_record ();
 524         void transport_roll ();
 525         void transport_play_selection();
 526         void transport_forward (int option);
 527         void transport_rewind (int option);
 528         void transport_loop ();
 529
 530         void transport_rolling ();
 531         void transport_rewinding ();
 532         void transport_forwarding ();
 533         void transport_stopped ();
 534
 535         bool _session_is_new;
 536         void connect_to_session (ARDOUR::Session *);
 537         void connect_dependents_to_session (ARDOUR::Session *);
 538         void we_have_dependents ();
 539
 540         std::string keybindings_path;
 541
 542         void setup_keybindings ();
 543         void setup_session_options ();
 544
 545         guint32  last_key_press_time;
 546
 547         void snapshot_session ();
 548
 549         Mixer_UI   *mixer;
 550         int         create_mixer ();
 551
 552         PublicEditor     *editor;
 553         int         create_editor ();
 554
 555         RouteParams_UI *route_params;
 556         int             create_route_params ();
 557
 558         ConnectionEditor *connection_editor;
 559         int               create_connection_editor ();
 560
 561         LocationUI *location_ui;
 562         int         create_location_ui ();
 563         void        handle_locations_change (ARDOUR::Location*);
 564
 565         ColorManager* color_manager;
 566
 567         /* Options window */
 568
 569         OptionEditor *option_editor;
 570
 571         /* route dialog */
 572
 573         AddRouteDialog *add_route_dialog;
 574
 575         /* Keyboard Handling */
 576
 577         Keyboard* keyboard;
 578
 579         /* Keymap handling */
 580
 581         void install_actions ();
 582         void start_keyboard_prefix();
 583
 584         void toggle_record_enable (uint32_t);
 585
 586         uint32_t rec_enabled_streams;
 587         void count_recenabled_streams (ARDOUR::Route&);
 588
 589         About* about;
 590         bool shown_flag;
 591         /* cleanup */
 592
 593         Gtk::MenuItem *cleanup_item;
 594
 595         void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
 596         void cleanup ();
 597         void flush_trash ();
 598
 599         bool have_configure_timeout;
 600         struct timeval last_configure_time;
 601         gint configure_timeout ();
 602
 603         struct timeval last_peak_grab;
 604         struct timeval last_shuttle_request;
 605
 606         bool have_disk_overrun_displayed;
 607         bool have_disk_underrun_displayed;
 608
 609         void disk_overrun_message_gone ();
 610         void disk_underrun_message_gone ();
 611         void disk_overrun_handler ();
 612         void disk_underrun_handler ();
 613
 614         int pending_state_dialog ();
 615
 616         void disconnect_from_jack ();
 617         void reconnect_to_jack ();
 618         void set_jack_buffer_size (nframes_t);
 619
 620         Gtk::MenuItem* jack_disconnect_item;
 621         Gtk::MenuItem* jack_reconnect_item;
 622         Gtk::Menu*     jack_bufsize_menu;
 623
 624         int make_session_clean ();
 625         bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
 626
 627         Glib::RefPtr<Gtk::ActionGroup> common_actions;
 628
 629         void editor_realized ();
 630
 631         std::vector<std::string> positional_sync_strings;
 632
 633         void toggle_send_midi_feedback ();
 634         void toggle_use_mmc ();
 635         void toggle_send_mmc ();
 636         void toggle_use_midi_control();
 637         void toggle_send_mtc ();
 638
 639         void set_input_auto_connect (ARDOUR::AutoConnectOption);
 640         void set_output_auto_connect (ARDOUR::AutoConnectOption);
 641         void set_solo_model (ARDOUR::SoloModel);
 642         void set_monitor_model (ARDOUR::MonitorModel);
 643
 644         void toggle_StopPluginsWithTransport();
 645         void toggle_DoNotRunPluginsWhileRecording();
 646         void toggle_VerifyRemoveLastCapture();
 647         void toggle_StopRecordingOnXrun();
 648         void toggle_StopTransportAtEndOfSession();
 649         void toggle_GainReduceFastTransport();
 650         void toggle_LatchedSolo();
 651         void toggle_LatchedRecordEnable ();
 652
 653         void mtc_port_changed ();
 654         void map_solo_model ();
 655         void map_monitor_model ();
 656         void map_file_header_format ();
 657         void map_file_data_format ();
 658         void map_input_auto_connect ();
 659         void map_output_auto_connect ();
 660         void parameter_changed (const char*);
 661
 662         void set_meter_hold (ARDOUR::MeterHold);
 663         void set_meter_falloff (ARDOUR::MeterFalloff);
 664         void map_meter_hold ();
 665         void map_meter_falloff ();
 666
 667         void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
 668         void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
 669 };
 670
 671 #endif /* __ardour_gui_h__ */
 672