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