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