revert VST debugging hacks
[ardour2.git] / gtk2_ardour / ardour_ui.h
bloba0c84a18d840d37dd6c054057f17b8b46b5bd66b
1 /*
2 Copyright (C) 1999-2002 Paul Davis
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.
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.
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.
20 #ifndef __ardour_gui_h__
21 #define __ardour_gui_h__
23 /* need _BSD_SOURCE to get timersub macros */
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
33 #include <list>
35 #include <cmath>
37 #include <libgnomecanvasmm/canvas.h>
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/textbuffer.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 <gtkmm2ext/bindable_button.h>
59 #include <ardour/ardour.h>
60 #include <ardour/session.h>
61 #include <ardour/types.h>
63 #include "audio_clock.h"
64 #include "ardour_dialog.h"
65 #include "editing.h"
66 #include "ui_config.h"
68 class AudioClock;
69 class PublicEditor;
70 class Keyboard;
71 class OptionEditor;
72 class KeyEditor;
73 class Mixer_UI;
74 class ConnectionEditor;
75 class RouteParams_UI;
76 class About;
77 class Splash;
78 class AddRouteDialog;
79 class LocationUI;
80 class ThemeManager;
81 class NewSessionDialog;
83 namespace Gtkmm2ext {
84 class TearOff;
87 namespace ARDOUR {
88 class AudioEngine;
89 class Route;
90 class Port;
91 class IO;
92 class ControlProtocolInfo;
95 namespace ALSA {
96 class MultiChannelDevice;
99 #define FRAME_NAME "BaseFrame"
101 extern sigc::signal<void> ColorsChanged;
102 extern sigc::signal<void> DPIReset;
104 class ARDOUR_UI : public Gtkmm2ext::UI
106 public:
107 ARDOUR_UI (int *argcp, char **argvp[]);
108 ~ARDOUR_UI();
110 void show ();
111 bool shown() { return shown_flag; }
113 void show_splash ();
114 void hide_splash ();
116 void show_about ();
117 void hide_about ();
119 void idle_load (const Glib::ustring& path);
120 void finish();
122 int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
123 bool session_loaded;
124 int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
125 uint32_t ctl_chns,
126 uint32_t master_chns,
127 ARDOUR::AutoConnectOption input_connect,
128 ARDOUR::AutoConnectOption output_connect,
129 uint32_t nphysin,
130 uint32_t nphysout,
131 nframes_t initial_length);
132 bool session_is_new() const { return _session_is_new; }
134 ARDOUR::Session* the_session() { return session; }
136 bool will_create_new_session_automatically() const {
137 return _will_create_new_session_automatically;
140 void set_will_create_new_session_automatically (bool yn) {
141 _will_create_new_session_automatically = yn;
144 bool get_session_parameters (bool have_engine = false, bool should_be_new = false);
145 void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
146 int load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
147 int build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
148 bool ask_about_loading_existing_session (const Glib::ustring& session_path);
149 int unload_session (bool hide_stuff = false);
150 void close_session();
152 int save_state_canfail (string state_name = "");
153 void save_state (const string & state_name = "");
155 static double gain_to_slider_position (ARDOUR::gain_t g);
156 static ARDOUR::gain_t slider_position_to_gain (double pos);
158 static ARDOUR_UI *instance () { return theArdourUI; }
159 static UIConfiguration *config () { return ui_config; }
161 PublicEditor& the_editor(){return *editor;}
162 Mixer_UI* the_mixer() { return mixer; }
164 ARDOUR::AudioEngine& the_engine() const { return *engine; }
166 void toggle_key_editor ();
167 void toggle_location_window ();
168 void toggle_theme_manager ();
169 void toggle_big_clock_window ();
170 void toggle_connection_editor ();
171 void toggle_route_params_window ();
172 void toggle_editing_space();
174 Gtk::Tooltips& tooltips() { return _tooltips; }
176 static sigc::signal<void,bool> Blink;
177 static sigc::signal<void> RapidScreenUpdate;
178 static sigc::signal<void> SuperRapidScreenUpdate;
179 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
181 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
183 XMLNode* editor_settings() const;
184 XMLNode* mixer_settings () const;
185 XMLNode* keyboard_settings () const;
187 void save_ardour_state ();
188 gboolean configure_handler (GdkEventConfigure* conf);
190 void do_transport_locate (nframes_t position);
191 void halt_on_xrun_message ();
192 void xrun_handler (nframes_t);
193 void create_xrun_marker (nframes_t);
195 AudioClock primary_clock;
196 AudioClock secondary_clock;
197 AudioClock preroll_clock;
198 AudioClock postroll_clock;
200 void store_clock_modes ();
201 void restore_clock_modes ();
203 void add_route (Gtk::Window* float_window);
205 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
206 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
209 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
210 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
213 void session_add_midi_track ();
215 int create_engine ();
216 void post_engine ();
218 gint exit_on_main_window_close (GdkEventAny *);
220 void maximise_editing_space ();
221 void restore_editing_space ();
223 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
224 void set_native_file_data_format (ARDOUR::SampleFormat sf);
226 void setup_profile ();
227 void setup_theme ();
229 void set_shuttle_fract (double);
231 protected:
232 friend class PublicEditor;
234 void toggle_clocking ();
235 void toggle_auto_play ();
236 void toggle_auto_input ();
237 void toggle_punch ();
238 void unset_dual_punch ();
239 bool ignore_dual_punch;
240 void toggle_punch_in ();
241 void toggle_punch_out ();
242 void toggle_auto_return ();
243 void toggle_click ();
245 void toggle_session_auto_loop ();
247 void toggle_options_window ();
249 private:
250 struct GlobalClickBox : public Gtk::VBox {
251 Gtkmm2ext::ClickBox *box;
252 Gtk::Frame frame;
253 Gtk::Label label;
254 vector<string> &strings;
255 Gtk::Adjustment adjustment;
257 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
259 GlobalClickBox (const string &str, vector<string> &vs)
260 : strings (vs),
261 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
262 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
263 label.set_text (str);
264 label.set_name ("GlobalButtonLabel");
265 frame.add (*box);
266 frame.set_shadow_type (Gtk::SHADOW_IN);
267 pack_start (label);
268 pack_start (frame);
269 box->set_print_func (printer, this);
270 box->set_wrap (true);
274 ARDOUR::AudioEngine *engine;
275 ARDOUR::Session *session;
277 Gtk::Tooltips _tooltips;
279 void goto_editor_window ();
280 void goto_mixer_window ();
281 void toggle_editor_mixer_on_top ();
282 bool _mixer_on_top;
284 GlobalClickBox *online_control_button;
285 vector<string> online_control_strings;
287 GlobalClickBox *crossfade_time_button;
288 vector<string> crossfade_time_strings;
290 Gtk::ToggleButton preroll_button;
291 Gtk::ToggleButton postroll_button;
293 int setup_windows ();
294 void setup_transport ();
295 void setup_clock ();
297 static ARDOUR_UI *theArdourUI;
299 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
300 void startup ();
301 void shutdown ();
303 int ask_about_saving_session (const string & why);
305 /* periodic safety backup, to be precise */
306 gint autosave_session();
307 void update_autosave();
308 sigc::connection _autosave_connection;
310 void queue_transport_change ();
311 void map_transport_state ();
312 int32_t do_engine_start ();
314 void engine_halted ();
315 void engine_stopped ();
316 void engine_running ();
318 void use_config ();
320 static gint _blink (void *);
321 void blink ();
322 gint blink_timeout_tag;
323 bool blink_on;
324 void start_blinking ();
325 void stop_blinking ();
327 void about_signal_response(int response);
330 private:
331 Gtk::VBox top_packer;
333 sigc::connection clock_signal_connection;
334 void update_clocks ();
335 void start_clocking ();
336 void stop_clocking ();
338 void manage_window (Gtk::Window&);
340 AudioClock big_clock;
341 Gtk::Window* big_clock_window;
343 void float_big_clock (Gtk::Window* parent);
344 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
346 void update_transport_clocks (nframes_t pos);
347 void record_state_changed ();
349 /* Transport Control */
351 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
352 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
354 Gtkmm2ext::TearOff* transport_tearoff;
355 Gtk::Frame transport_frame;
356 Gtk::HBox transport_tearoff_hbox;
357 Gtk::HBox transport_hbox;
358 Gtk::Fixed transport_base;
359 Gtk::Fixed transport_button_base;
360 Gtk::Frame transport_button_frame;
361 Gtk::HBox transport_button_hbox;
362 Gtk::VBox transport_button_vbox;
363 Gtk::HBox transport_option_button_hbox;
364 Gtk::VBox transport_option_button_vbox;
365 Gtk::HBox transport_clock_hbox;
366 Gtk::VBox transport_clock_vbox;
367 Gtk::HBox primary_clock_hbox;
368 Gtk::HBox secondary_clock_hbox;
371 struct TransportControllable : public PBD::Controllable {
372 enum ToggleType {
373 Roll = 0,
374 Stop,
375 RecordEnable,
376 GotoStart,
377 GotoEnd,
378 AutoLoop,
379 PlaySelection,
380 ShuttleControl
384 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
385 void set_value (float);
386 float get_value (void) const;
388 void set_id (const std::string&);
390 ARDOUR_UI& ui;
391 ToggleType type;
394 TransportControllable roll_controllable;
395 TransportControllable stop_controllable;
396 TransportControllable goto_start_controllable;
397 TransportControllable goto_end_controllable;
398 TransportControllable auto_loop_controllable;
399 TransportControllable play_selection_controllable;
400 TransportControllable rec_controllable;
401 TransportControllable shuttle_controllable;
402 BindingProxy shuttle_controller_binding_proxy;
404 void set_transport_controllable_state (const XMLNode&);
405 XMLNode& get_transport_controllable_state ();
407 BindableButton roll_button;
408 BindableButton stop_button;
409 BindableButton goto_start_button;
410 BindableButton goto_end_button;
411 BindableButton auto_loop_button;
412 BindableButton play_selection_button;
413 BindableButton rec_button;
415 Gtk::ComboBoxText sync_option_combo;
417 void sync_option_changed ();
418 void toggle_time_master ();
419 void toggle_video_sync ();
421 Gtk::DrawingArea shuttle_box;
422 Gtk::EventBox speed_display_box;
423 Gtk::Label speed_display_label;
424 Gtk::Button shuttle_units_button;
425 Gtk::ComboBoxText shuttle_style_button;
426 Gtk::Menu* shuttle_unit_menu;
427 Gtk::Menu* shuttle_style_menu;
428 float shuttle_max_speed;
429 Gtk::Menu* shuttle_context_menu;
431 void build_shuttle_context_menu ();
432 void show_shuttle_context_menu ();
433 void shuttle_style_changed();
434 void shuttle_unit_clicked ();
435 void set_shuttle_max_speed (float);
436 void update_speed_display ();
437 float last_speed_displayed;
439 gint shuttle_box_button_press (GdkEventButton*);
440 gint shuttle_box_button_release (GdkEventButton*);
441 gint shuttle_box_scroll (GdkEventScroll*);
442 gint shuttle_box_motion (GdkEventMotion*);
443 gint shuttle_box_expose (GdkEventExpose*);
444 gint mouse_shuttle (double x, bool force);
445 void use_shuttle_fract (bool force);
447 bool shuttle_grabbed;
448 double shuttle_fract;
450 Gtkmm2ext::StatefulToggleButton punch_in_button;
451 Gtkmm2ext::StatefulToggleButton punch_out_button;
452 Gtkmm2ext::StatefulToggleButton auto_return_button;
453 Gtkmm2ext::StatefulToggleButton auto_play_button;
454 Gtkmm2ext::StatefulToggleButton auto_input_button;
455 Gtkmm2ext::StatefulToggleButton click_button;
456 Gtkmm2ext::StatefulToggleButton time_master_button;
458 Gtk::ToggleButton auditioning_alert_button;
459 Gtk::ToggleButton solo_alert_button;
461 Gtk::VBox alert_box;
463 void solo_blink (bool);
464 void audition_blink (bool);
466 void soloing_changed (bool);
467 void auditioning_changed (bool);
468 void _auditioning_changed (bool);
470 void solo_alert_toggle ();
471 void audition_alert_toggle ();
473 void big_clock_value_changed ();
474 void primary_clock_value_changed ();
475 void secondary_clock_value_changed ();
477 /* called by Blink signal */
479 void transport_rec_enable_blink (bool onoff);
481 Gtk::Menu* session_popup_menu;
483 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
484 RecentSessionModelColumns() {
485 add (visible_name);
486 add (fullpath);
488 Gtk::TreeModelColumn<Glib::ustring> visible_name;
489 Gtk::TreeModelColumn<Glib::ustring> fullpath;
492 RecentSessionModelColumns recent_session_columns;
493 Gtk::TreeView recent_session_display;
494 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
496 ArdourDialog* session_selector_window;
497 Gtk::FileChooserDialog* open_session_selector;
499 void build_session_selector();
500 void redisplay_recent_sessions();
501 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
503 struct RecentSessionsSorter {
504 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
505 return cmp_nocase(a.first, b.first) == -1;
509 /* menu bar and associated stuff */
511 Gtk::MenuBar* menu_bar;
512 Gtk::EventBox menu_bar_base;
513 Gtk::HBox menu_hbox;
515 void use_menubar_as_top_menubar ();
517 void build_menu_bar ();
518 void build_control_surface_menu ();
520 Gtk::Label wall_clock_label;
521 Gtk::EventBox wall_clock_box;
522 gint update_wall_clock ();
524 Gtk::Label disk_space_label;
525 Gtk::EventBox disk_space_box;
526 void update_disk_space ();
528 Gtk::Label cpu_load_label;
529 Gtk::EventBox cpu_load_box;
530 void update_cpu_load ();
532 Gtk::Label buffer_load_label;
533 Gtk::EventBox buffer_load_box;
534 void update_buffer_load ();
536 Gtk::Label sample_rate_label;
537 Gtk::EventBox sample_rate_box;
538 void update_sample_rate (nframes_t);
540 gint every_second ();
541 gint every_point_one_seconds ();
542 gint every_point_zero_one_seconds ();
544 sigc::connection second_connection;
545 sigc::connection point_one_second_connection;
546 sigc::connection point_oh_five_second_connection;
547 sigc::connection point_zero_one_second_connection;
549 gint session_menu (GdkEventButton *);
551 bool _will_create_new_session_automatically;
553 NewSessionDialog* new_session_dialog;
555 void open_session ();
556 void open_recent_session ();
557 void save_template ();
559 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
561 void set_transport_sensitivity (bool);
563 void remove_last_capture ();
565 void transport_goto_zero ();
566 void transport_goto_start ();
567 void transport_goto_end ();
568 void transport_goto_wallclock ();
569 void transport_stop ();
570 void transport_stop_and_forget_capture ();
571 void transport_record (bool roll);
572 void transport_roll ();
573 void transport_play_selection();
574 void transport_forward (int option);
575 void transport_rewind (int option);
576 void transport_loop ();
578 void transport_rolling ();
579 void transport_rewinding ();
580 void transport_forwarding ();
581 void transport_stopped ();
583 bool _session_is_new;
584 void connect_to_session (ARDOUR::Session *);
585 void connect_dependents_to_session (ARDOUR::Session *);
586 void we_have_dependents ();
588 void setup_session_options ();
590 guint32 last_key_press_time;
592 void snapshot_session ();
594 Mixer_UI *mixer;
595 int create_mixer ();
597 PublicEditor *editor;
598 int create_editor ();
600 RouteParams_UI *route_params;
601 int create_route_params ();
603 ConnectionEditor *connection_editor;
604 int create_connection_editor ();
606 LocationUI *location_ui;
607 int create_location_ui ();
608 void handle_locations_change (ARDOUR::Location*);
610 static UIConfiguration *ui_config;
611 ThemeManager *theme_manager;
613 /* Key bindings editor */
615 KeyEditor *key_editor;
617 /* Options window */
619 OptionEditor *option_editor;
621 /* route dialog */
623 AddRouteDialog *add_route_dialog;
625 /* Keyboard Handling */
627 Keyboard* keyboard;
629 /* Keymap handling */
631 void install_actions ();
633 void toggle_record_enable (uint32_t);
635 uint32_t rec_enabled_streams;
636 void count_recenabled_streams (ARDOUR::Route&);
638 About* about;
639 Splash* splash;
640 void pop_back_splash ();
641 bool shown_flag;
643 /* cleanup */
645 Gtk::MenuItem *cleanup_item;
647 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
648 void cleanup ();
649 void flush_trash ();
651 bool have_configure_timeout;
652 ARDOUR::microseconds_t last_configure_time;
653 gint configure_timeout ();
655 ARDOUR::microseconds_t last_peak_grab;
656 ARDOUR::microseconds_t last_shuttle_request;
658 bool have_disk_speed_dialog_displayed;
659 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
660 void disk_overrun_handler ();
661 void disk_underrun_handler ();
663 bool preset_file_exists_handler ();
665 void session_dialog (std::string);
666 int pending_state_dialog ();
667 int sr_mismatch_dialog (nframes_t, nframes_t);
669 void disconnect_from_jack ();
670 void reconnect_to_jack ();
671 void set_jack_buffer_size (nframes_t);
673 Gtk::MenuItem* jack_disconnect_item;
674 Gtk::MenuItem* jack_reconnect_item;
675 Gtk::Menu* jack_bufsize_menu;
677 Glib::RefPtr<Gtk::ActionGroup> common_actions;
679 void editor_realized ();
681 std::vector<std::string> positional_sync_strings;
683 void toggle_send_midi_feedback ();
684 void toggle_use_mmc ();
685 void toggle_send_mmc ();
686 void toggle_send_mtc ();
688 void toggle_use_osc ();
690 void toggle_denormal_protection ();
692 void set_input_auto_connect (ARDOUR::AutoConnectOption);
693 void set_output_auto_connect (ARDOUR::AutoConnectOption);
694 void set_solo_model (ARDOUR::SoloModel);
695 void set_monitor_model (ARDOUR::MonitorModel);
696 void set_remote_model (ARDOUR::RemoteModel);
697 void set_denormal_model (ARDOUR::DenormalModel);
699 void toggle_sync_order_keys ();
700 void toggle_new_plugins_active();
701 void toggle_StopPluginsWithTransport();
702 void toggle_DoNotRunPluginsWhileRecording();
703 void toggle_VerifyRemoveLastCapture();
704 void toggle_PeriodicSafetyBackups();
705 void toggle_StopRecordingOnXrun();
706 void toggle_CreateXrunMarker();
707 void toggle_StopTransportAtEndOfSession();
708 void toggle_GainReduceFastTransport();
709 void toggle_LatchedSolo();
710 void toggle_ShowSoloMutes();
711 void toggle_SoloMuteOverride();
712 void toggle_LatchedRecordEnable ();
713 void toggle_RegionEquivalentsOverlap ();
714 void toggle_PrimaryClockDeltaEditCursor ();
715 void toggle_SecondaryClockDeltaEditCursor ();
716 void toggle_only_copy_imported_files ();
717 void toggle_ShowTrackMeters ();
718 void toggle_use_narrow_ms();
719 void toggle_NameNewMarkers ();
720 void toggle_rubberbanding_snaps_to_grid ();
721 void toggle_auto_analyse_audio ();
722 void toggle_TapeMachineMode();
724 void mtc_port_changed ();
725 void map_solo_model ();
726 void map_monitor_model ();
727 void map_denormal_model ();
728 void map_denormal_protection ();
729 void map_remote_model ();
730 void map_file_header_format ();
731 void map_file_data_format ();
732 void map_input_auto_connect ();
733 void map_output_auto_connect ();
734 void map_only_copy_imported_files ();
735 void parameter_changed (const char*);
737 void set_meter_hold (ARDOUR::MeterHold);
738 void set_meter_falloff (ARDOUR::MeterFalloff);
739 void map_meter_hold ();
740 void map_meter_falloff ();
742 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
743 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
745 bool first_idle ();
747 void no_memory_warning ();
748 void check_memory_locking ();
750 bool check_audioengine();
751 void audioengine_setup ();
753 void display_message (const char *prefix, gint prefix_len,
754 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
755 Gtk::Label status_bar_label;
756 Gtk::ToggleButton error_log_button;
758 void loading_message (const std::string& msg);
759 void end_loading_messages ();
761 void platform_specific ();
762 void platform_setup ();
763 void fontconfig_dialog ();
766 #endif /* __ardour_gui_h__ */