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(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 store_clock_modes ();
 188         void restore_clock_modes ();
 189
 190         void add_route ();
 191
 192         void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
 193                 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
 194         }
 195
 196         void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
 197                 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
 198         }
 199
 200         void session_add_midi_track (uint32_t how_many) {
 201                 session_add_midi_route (true, how_many);
 202         }
 203
 204         /*void session_add_midi_bus () {
 205                 session_add_midi_route (false);
 206         }*/
 207
 208         void set_engine (ARDOUR::AudioEngine&);
 209         gint start_engine ();
 210
 211         gint exit_on_main_window_close (GdkEventAny *);
 212
 213         void maximise_editing_space ();
 214         void restore_editing_space ();
 215
 216         void set_native_file_header_format (ARDOUR::HeaderFormat sf);
 217         void set_native_file_data_format (ARDOUR::SampleFormat sf);
 218
 219         void set_keybindings_path (std::string path);
 220         void save_keybindings ();
 221
 222   protected:
 223         friend class PublicEditor;
 224
 225         void toggle_clocking ();
 226         void toggle_auto_play ();
 227         void toggle_auto_input ();
 228         void toggle_punch_in ();
 229         void toggle_punch_out ();
 230         void toggle_auto_return ();
 231         void toggle_click ();
 232
 233         void toggle_session_auto_loop ();
 234
 235         void toggle_options_window ();
 236
 237   private:
 238         struct GlobalClickBox : public Gtk::VBox {
 239             Gtkmm2ext::ClickBox  *box;
 240             Gtk::Frame      frame;
 241             Gtk::Label      label;
 242             vector<string> &strings;
 243             Gtk::Adjustment adjustment;
 244
 245             static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
 246
 247             GlobalClickBox (const string &str, vector<string> &vs)
 248                     : strings (vs),
 249                       adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
 250                     box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
 251                     label.set_text (str);
 252                     label.set_name ("GlobalButtonLabel");
 253                     frame.add (*box);
 254                     frame.set_shadow_type (Gtk::SHADOW_IN);
 255                     pack_start (label);
 256                     pack_start (frame);
 257                     box->set_print_func (printer, this);
 258                     box->set_wrap (true);
 259             };
 260         };
 261
 262         ARDOUR::AudioEngine                 *engine;
 263         ARDOUR::Session                     *session;
 264
 265         Gtk::Tooltips          _tooltips;
 266
 267         void                     goto_editor_window ();
 268         void                     goto_mixer_window ();
 269
 270         Gtk::Table               adjuster_table;
 271         Gtk::Frame               adjuster_frame;
 272         Gtk::Fixed               adjuster_base;
 273
 274         GlobalClickBox     *online_control_button;
 275         vector<string>      online_control_strings;
 276
 277         GlobalClickBox    *crossfade_time_button;
 278         vector<string>     crossfade_time_strings;
 279
 280         GlobalClickBox    *mmc_id_button;
 281         vector<string>     mmc_id_strings;
 282
 283         Gtk::ToggleButton   preroll_button;
 284         Gtk::ToggleButton   postroll_button;
 285
 286         Gtk::Table          transport_table;
 287         Gtk::Table          option_table;
 288
 289         int  setup_windows ();
 290         void setup_transport ();
 291         void setup_clock ();
 292         void setup_adjustables ();
 293
 294         static ARDOUR_UI *theArdourUI;
 295
 296         void startup ();
 297         void shutdown ();
 298
 299         void finish();
 300         int  ask_about_saving_session (const string & why);
 301         int  save_the_session;
 302
 303         void queue_transport_change ();
 304         void map_transport_state ();
 305         int32_t do_engine_start ();
 306
 307         void engine_halted ();
 308         void engine_stopped ();
 309         void engine_running ();
 310
 311         void use_config ();
 312
 313         static gint _blink  (void *);
 314         void blink ();
 315         gint blink_timeout_tag;
 316         bool blink_on;
 317         void start_blinking ();
 318         void stop_blinking ();
 319
 320         void control_methods_adjusted ();
 321         void mmc_device_id_adjusted ();
 322
 323         void about_signal_response(int response);
 324
 325   private:
 326         Gtk::VBox     top_packer;
 327
 328         sigc::connection clock_signal_connection;
 329         void         update_clocks ();
 330         void         start_clocking ();
 331         void         stop_clocking ();
 332
 333         void manage_window (Gtk::Window&);
 334
 335         AudioClock   big_clock;
 336         Gtk::Frame   big_clock_frame;
 337         Gtk::Window* big_clock_window;
 338
 339         void update_transport_clocks (nframes_t pos);
 340         void record_state_changed ();
 341
 342         /* Transport Control */
 343
 344         void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
 345         void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
 346
 347         Gtkmm2ext::TearOff*      transport_tearoff;
 348         Gtk::Frame               transport_frame;
 349         Gtk::HBox                transport_tearoff_hbox;
 350         Gtk::HBox                transport_hbox;
 351         Gtk::Fixed               transport_base;
 352         Gtk::Fixed               transport_button_base;
 353         Gtk::Frame               transport_button_frame;
 354         Gtk::HBox                transport_button_hbox;
 355         Gtk::VBox                transport_button_vbox;
 356         Gtk::HBox                transport_option_button_hbox;
 357         Gtk::VBox                transport_option_button_vbox;
 358         Gtk::HBox                transport_clock_hbox;
 359         Gtk::VBox                transport_clock_vbox;
 360         Gtk::HBox                primary_clock_hbox;
 361         Gtk::HBox                secondary_clock_hbox;
 362
 363         Gtkmm2ext::StatefulButton roll_button;
 364         Gtkmm2ext::StatefulButton stop_button;
 365         Gtkmm2ext::StatefulButton rewind_button;
 366         Gtkmm2ext::StatefulButton forward_button;
 367         Gtkmm2ext::StatefulButton goto_start_button;
 368         Gtkmm2ext::StatefulButton goto_end_button;
 369         Gtkmm2ext::StatefulButton auto_loop_button;
 370         Gtkmm2ext::StatefulButton play_selection_button;
 371
 372         Gtkmm2ext::StatefulButton rec_button;
 373
 374         Gtk::ToggleButton time_master_button;
 375         Gtk::ComboBoxText sync_option_combo;
 376
 377         void sync_option_changed ();
 378         void toggle_time_master ();
 379         void toggle_video_sync ();
 380
 381         Gtk::DrawingArea  shuttle_box;
 382         Gtk::EventBox     speed_display_box;
 383         Gtk::Label        speed_display_label;
 384         Gtk::Button       shuttle_units_button;
 385         Gtk::ComboBoxText shuttle_style_button;
 386         Gtk::Menu*        shuttle_unit_menu;
 387         Gtk::Menu*        shuttle_style_menu;
 388         float             shuttle_max_speed;
 389         Gtk::Menu*        shuttle_context_menu;
 390
 391         void build_shuttle_context_menu ();
 392         void show_shuttle_context_menu ();
 393         void shuttle_style_changed();
 394         void shuttle_unit_clicked ();
 395         void set_shuttle_max_speed (float);
 396         void update_speed_display ();
 397         float last_speed_displayed;
 398
 399         gint shuttle_box_button_press (GdkEventButton*);
 400         gint shuttle_box_button_release (GdkEventButton*);
 401         gint shuttle_box_scroll (GdkEventScroll*);
 402         gint shuttle_box_motion (GdkEventMotion*);
 403         gint shuttle_box_expose (GdkEventExpose*);
 404         gint mouse_shuttle (double x, bool force);
 405         void use_shuttle_fract (bool force);
 406
 407         bool   shuttle_grabbed;
 408         double shuttle_fract;
 409
 410         Gtk::ToggleButton punch_in_button;
 411         Gtk::ToggleButton punch_out_button;
 412         Gtk::ToggleButton auto_return_button;
 413         Gtk::ToggleButton auto_play_button;
 414         Gtk::ToggleButton auto_input_button;
 415         Gtk::ToggleButton click_button;
 416         Gtk::ToggleButton auditioning_alert_button;
 417         Gtk::ToggleButton solo_alert_button;
 418
 419         Gtk::VBox alert_box;
 420
 421         void solo_blink (bool);
 422         void audition_blink (bool);
 423
 424         void soloing_changed (bool);
 425         void auditioning_changed (bool);
 426         void _auditioning_changed (bool);
 427
 428         void solo_alert_toggle ();
 429         void audition_alert_toggle ();
 430
 431         void primary_clock_value_changed ();
 432         void secondary_clock_value_changed ();
 433
 434         /* called by Blink signal */
 435
 436         void transport_rec_enable_blink (bool onoff);
 437
 438         /* These change where we accept control from:
 439            MMC, X (local) or both.
 440         */
 441
 442         void allow_mmc_only ();
 443         void allow_mmc_and_local ();
 444         void allow_local_only ();
 445
 446         Gtk::Menu*        session_popup_menu;
 447
 448         struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
 449             RecentSessionModelColumns() {
 450                     add (visible_name);
 451                     add (fullpath);
 452             }
 453             Gtk::TreeModelColumn<Glib::ustring> visible_name;
 454             Gtk::TreeModelColumn<Glib::ustring> fullpath;
 455         };
 456
 457         RecentSessionModelColumns    recent_session_columns;
 458         Gtk::TreeView                recent_session_display;
 459         Glib::RefPtr<Gtk::TreeStore> recent_session_model;
 460
 461         ArdourDialog*     session_selector_window;
 462         Gtk::FileChooserDialog* open_session_selector;
 463
 464         void build_session_selector();
 465         void redisplay_recent_sessions();
 466         void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
 467
 468         struct RecentSessionsSorter {
 469             bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
 470                     return cmp_nocase(a.first, b.first) == -1;
 471             }
 472         };
 473
 474         /* menu bar and associated stuff */
 475
 476         Gtk::MenuBar* menu_bar;
 477         Gtk::EventBox menu_bar_base;
 478         Gtk::HBox     menu_hbox;
 479
 480         void build_menu_bar ();
 481         void build_control_surface_menu ();
 482
 483         Gtk::Label   wall_clock_label;
 484         Gtk::EventBox wall_clock_box;
 485         gint update_wall_clock ();
 486
 487         Gtk::Label   disk_space_label;
 488         Gtk::EventBox disk_space_box;
 489         void update_disk_space ();
 490
 491         Gtk::Label   cpu_load_label;
 492         Gtk::EventBox cpu_load_box;
 493         void update_cpu_load ();
 494
 495         Gtk::Label   buffer_load_label;
 496         Gtk::EventBox buffer_load_box;
 497         void update_buffer_load ();
 498
 499         Gtk::Label   sample_rate_label;
 500         Gtk::EventBox sample_rate_box;
 501         void update_sample_rate (nframes_t);
 502
 503         gint every_second ();
 504         gint every_point_one_seconds ();
 505         gint every_point_zero_one_seconds ();
 506
 507         sigc::connection second_connection;
 508         sigc::connection point_one_second_connection;
 509         sigc::connection point_zero_one_second_connection;
 510
 511         gint session_menu (GdkEventButton *);
 512
 513         bool _will_create_new_session_automatically;
 514
 515         NewSessionDialog* new_session_dialog;
 516
 517         void open_session ();
 518         void open_recent_session ();
 519         void save_template ();
 520
 521         void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
 522         void session_add_midi_route (bool disk, uint32_t how_many);
 523
 524         void set_transport_sensitivity (bool);
 525
 526         void remove_last_capture ();
 527
 528         void transport_goto_zero ();
 529         void transport_goto_start ();
 530         void transport_goto_end ();
 531         void transport_stop ();
 532         void transport_stop_and_forget_capture ();
 533         void transport_record ();
 534         void transport_roll ();
 535         void transport_play_selection();
 536         void transport_forward (int option);
 537         void transport_rewind (int option);
 538         void transport_loop ();
 539
 540         void transport_rolling ();
 541         void transport_rewinding ();
 542         void transport_forwarding ();
 543         void transport_stopped ();
 544
 545         bool _session_is_new;
 546         void connect_to_session (ARDOUR::Session *);
 547         void connect_dependents_to_session (ARDOUR::Session *);
 548         void we_have_dependents ();
 549
 550         std::string keybindings_path;
 551
 552         void setup_keybindings ();
 553         void setup_session_options ();
 554
 555         guint32  last_key_press_time;
 556
 557         void snapshot_session ();
 558
 559         Mixer_UI   *mixer;
 560         int         create_mixer ();
 561
 562         PublicEditor     *editor;
 563         int         create_editor ();
 564
 565         RouteParams_UI *route_params;
 566         int             create_route_params ();
 567
 568         ConnectionEditor *connection_editor;
 569         int               create_connection_editor ();
 570
 571         LocationUI *location_ui;
 572         int         create_location_ui ();
 573         void        handle_locations_change (ARDOUR::Location*);
 574
 575         ColorManager* color_manager;
 576
 577         /* Options window */
 578
 579         OptionEditor *option_editor;
 580
 581         /* route dialog */
 582
 583         AddRouteDialog *add_route_dialog;
 584
 585         /* Keyboard Handling */
 586
 587         Keyboard* keyboard;
 588
 589         /* Keymap handling */
 590
 591         void install_actions ();
 592         void start_keyboard_prefix();
 593
 594         void toggle_record_enable (uint32_t);
 595
 596         uint32_t rec_enabled_streams;
 597         void count_recenabled_streams (ARDOUR::Route&);
 598
 599         About* about;
 600         bool shown_flag;
 601         /* cleanup */
 602
 603         Gtk::MenuItem *cleanup_item;
 604
 605         void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
 606         void cleanup ();
 607         void flush_trash ();
 608
 609         bool have_configure_timeout;
 610         struct timeval last_configure_time;
 611         gint configure_timeout ();
 612
 613         struct timeval last_peak_grab;
 614         struct timeval last_shuttle_request;
 615
 616         bool have_disk_overrun_displayed;
 617         bool have_disk_underrun_displayed;
 618
 619         void disk_overrun_message_gone ();
 620         void disk_underrun_message_gone ();
 621         void disk_overrun_handler ();
 622         void disk_underrun_handler ();
 623
 624         int pending_state_dialog ();
 625
 626         void disconnect_from_jack ();
 627         void reconnect_to_jack ();
 628         void set_jack_buffer_size (nframes_t);
 629
 630         Gtk::MenuItem* jack_disconnect_item;
 631         Gtk::MenuItem* jack_reconnect_item;
 632         Gtk::Menu*     jack_bufsize_menu;
 633
 634         int make_session_clean ();
 635         bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
 636
 637         Glib::RefPtr<Gtk::ActionGroup> common_actions;
 638
 639         void editor_realized ();
 640
 641         std::vector<std::string> positional_sync_strings;
 642
 643         void toggle_send_midi_feedback ();
 644         void toggle_use_mmc ();
 645         void toggle_send_mmc ();
 646         void toggle_use_midi_control();
 647         void toggle_send_mtc ();
 648
 649         void set_input_auto_connect (ARDOUR::AutoConnectOption);
 650         void set_output_auto_connect (ARDOUR::AutoConnectOption);
 651         void set_solo_model (ARDOUR::SoloModel);
 652         void set_monitor_model (ARDOUR::MonitorModel);
 653
 654         void toggle_StopPluginsWithTransport();
 655         void toggle_DoNotRunPluginsWhileRecording();
 656         void toggle_VerifyRemoveLastCapture();
 657         void toggle_StopRecordingOnXrun();
 658         void toggle_StopTransportAtEndOfSession();
 659         void toggle_GainReduceFastTransport();
 660         void toggle_LatchedSolo();
 661         void toggle_LatchedRecordEnable ();
 662
 663         void mtc_port_changed ();
 664         void map_solo_model ();
 665         void map_monitor_model ();
 666         void map_file_header_format ();
 667         void map_file_data_format ();
 668         void map_input_auto_connect ();
 669         void map_output_auto_connect ();
 670         void parameter_changed (const char*);
 671
 672         void set_meter_hold (ARDOUR::MeterHold);
 673         void set_meter_falloff (ARDOUR::MeterFalloff);
 674         void map_meter_hold ();
 675         void map_meter_falloff ();
 676
 677         void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
 678         void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
 679
 680         bool can_save_keybindings;
 681         bool first_idle ();
 682 };
 683
 684 #endif /* __ardour_gui_h__ */
 685