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__
25 /* need _BSD_SOURCE to get timersub macros */
39 #include "pbd/xml++.h"
40 #include "pbd/controllable.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/textbuffer.h>
55 #include <gtkmm/adjustment.h>
56 #include <gtkmm2ext/gtk_ui.h>
57 #include <gtkmm2ext/click_box.h>
58 #include <gtkmm2ext/stateful_button.h>
59 #include <gtkmm2ext/bindable_button.h>
61 #include "ardour/ardour.h"
62 #include "ardour/types.h"
63 #include "ardour/utils.h"
64 #include "ardour/plugin.h"
65 #include "ardour/session_handle.h"
66 #include "ardour/system_exec.h"
68 #include "video_timeline.h"
71 #include "ardour_button.h"
72 #include "ardour_dialog.h"
73 #include "ardour_window.h"
75 #include "engine_dialog.h"
76 #include "meterbridge.h"
77 #include "ui_config.h"
79 #include "visibility_group.h"
80 #include "window_manager.h"
82 #include "add_route_dialog.h"
83 #include "add_video_dialog.h"
84 #include "big_clock_window.h"
85 #include "bundle_manager.h"
86 #include "global_port_matrix.h"
87 #include "keyeditor.h"
88 #include "location_ui.h"
89 #include "rc_option_editor.h"
90 #include "route_params_ui.h"
91 #include "session_option_editor.h"
92 #include "speaker_dialog.h"
93 #include "theme_manager.h"
99 class ConnectionEditor;
103 class RCOptionEditor;
104 class RouteParams_UI;
106 class SessionOptionEditor;
107 class ShuttleControl;
112 class LevelMeterHBox;
113 class GUIObjectState;
115 namespace Gtkmm2ext {
120 class ControlProtocolInfo;
129 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
132 ARDOUR_UI (int *argcp, char **argvp[], const char* localedir);
135 bool run_startup (bool should_be_new, std::string load_template);
141 void launch_manual ();
142 void launch_reference ();
146 void idle_load (const std::string& path);
149 int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
151 int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
152 bool session_is_new() const { return _session_is_new; }
154 ARDOUR::Session* the_session() { return _session; }
156 bool get_smart_mode () const;
158 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
159 int build_session_from_dialog (SessionDialog&, const std::string& session_name, const std::string& session_path);
160 bool ask_about_loading_existing_session (const std::string& session_path);
162 /// @return true if session was successfully unloaded.
163 int unload_session (bool hide_stuff = false);
164 void close_session();
166 int save_state_canfail (std::string state_name = "", bool switch_to_it = false);
167 void save_state (const std::string & state_name = "", bool switch_to_it = false);
169 static ARDOUR_UI *instance () { return theArdourUI; }
170 static UIConfiguration *config () { return ui_config; }
172 PublicEditor& the_editor(){return *editor;}
173 Mixer_UI* the_mixer() { return mixer; }
175 void new_midi_tracer_window ();
176 void toggle_editing_space();
177 void toggle_mixer_space();
178 void toggle_keep_tearoffs();
180 Gtk::Tooltips& tooltips() { return _tooltips; }
182 Gtk::HBox& editor_transport_box() { return _editor_transport_box; }
184 static PublicEditor* _instance;
185 static sigc::signal<void,bool> Blink;
187 /** point_zero_one_seconds -- 10Hz ^= 100ms */
188 static sigc::signal<void> RapidScreenUpdate;
190 /** point_zero_something_seconds -- currently 25Hz ^= 40ms */
191 static sigc::signal<void> SuperRapidScreenUpdate;
193 /** Emitted frequently with the audible frame, false, and the edit point as
194 * parameters respectively.
196 * (either RapidScreenUpdate || SuperRapidScreenUpdate - user-config)
198 static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
200 static void close_all_dialogs () { CloseAllDialogs(); }
201 static sigc::signal<void> CloseAllDialogs;
203 XMLNode* editor_settings() const;
204 XMLNode* mixer_settings () const;
205 XMLNode* keyboard_settings () const;
206 XMLNode* tearoff_settings (const char*) const;
208 void save_ardour_state ();
209 gboolean configure_handler (GdkEventConfigure* conf);
211 void halt_on_xrun_message ();
212 void xrun_handler (framepos_t);
213 void create_xrun_marker (framepos_t);
215 GUIObjectState* gui_object_state;
217 MainClock* primary_clock;
218 MainClock* secondary_clock;
219 void focus_on_clock ();
220 AudioClock* big_clock;
222 TimeInfoBox* time_info_box;
224 VideoTimeLine *video_timeline;
226 void store_clock_modes ();
227 void restore_clock_modes ();
228 void reset_main_clocks ();
230 void synchronize_sync_source_and_video_pullup ();
232 void add_route (Gtk::Window* float_window);
233 void add_routes_part_two ();
234 void add_routes_thread ();
236 void add_video (Gtk::Window* float_window);
237 void remove_video ();
238 void start_video_server_menu (Gtk::Window* float_window);
239 bool start_video_server (Gtk::Window* float_window, bool popup_msg);
240 void stop_video_server (bool ask_confirm=false);
241 void flush_videotimeline_cache (bool localcacheonly=false);
243 void session_add_audio_track (
245 int32_t output_channels,
246 ARDOUR::TrackMode mode,
247 ARDOUR::RouteGroup* route_group,
249 std::string const & name_template
252 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
255 void session_add_audio_bus (int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group,
256 uint32_t how_many, std::string const & name_template) {
257 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
260 void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many, std::string const & name_template,
261 ARDOUR::PluginInfoPtr instrument) {
262 session_add_midi_route (true, route_group, how_many, name_template, instrument);
265 void session_add_mixed_track (const ARDOUR::ChanCount& input, const ARDOUR::ChanCount& output, ARDOUR::RouteGroup* route_group, uint32_t how_many, std::string const & name_template,
266 ARDOUR::PluginInfoPtr instrument);
268 /*void session_add_midi_bus () {
269 session_add_midi_route (false);
272 void attach_to_engine ();
275 gint exit_on_main_window_close (GdkEventAny *);
277 void maximise_editing_space ();
278 void restore_editing_space ();
280 void show_ui_prefs ();
282 void update_tearoff_visibility ();
284 void setup_profile ();
285 void setup_tooltips ();
287 void set_shuttle_fract (double);
289 void get_process_buffers ();
290 void drop_process_buffers ();
292 void reset_peak_display ();
293 void reset_route_peak_display (ARDOUR::Route*);
294 void reset_group_peak_display (ARDOUR::RouteGroup*);
296 const std::string& announce_string() const { return _announce_string; }
298 int disconnect_from_engine ();
299 int reconnect_to_engine ();
302 friend class PublicEditor;
304 void toggle_auto_play ();
305 void toggle_auto_input ();
306 void toggle_punch ();
307 void unset_dual_punch ();
308 bool ignore_dual_punch;
309 void toggle_punch_in ();
310 void toggle_punch_out ();
311 void show_loop_punch_ruler_and_disallow_hide ();
312 void reenable_hide_loop_punch_ruler_if_appropriate ();
313 void toggle_auto_return ();
314 void toggle_click ();
315 void toggle_audio_midi_setup ();
316 void toggle_session_auto_loop ();
317 void toggle_rc_options_window ();
318 void toggle_session_options_window ();
321 Gtk::Tooltips _tooltips;
325 bool first_time_engine_run;
327 void goto_editor_window ();
328 void goto_mixer_window ();
329 void toggle_mixer_window ();
330 void toggle_meterbridge ();
331 void toggle_editor_mixer ();
333 int setup_windows ();
334 void setup_transport ();
337 static ARDOUR_UI *theArdourUI;
341 int ask_about_saving_session (const std::vector<std::string>& actions);
343 /* periodic safety backup, to be precise */
344 gint autosave_session();
345 void update_autosave();
346 sigc::connection _autosave_connection;
348 void map_transport_state ();
349 int32_t do_engine_start ();
351 void engine_halted (const char* reason, bool free_reason);
352 void engine_stopped ();
353 void engine_running ();
357 static gint _blink (void *);
359 gint blink_timeout_tag;
361 void start_blinking ();
362 void stop_blinking ();
364 void about_signal_response(int response);
366 Gtk::VBox top_packer;
368 sigc::connection clock_signal_connection;
369 void update_clocks ();
370 void start_clocking ();
371 void stop_clocking ();
373 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
375 void update_transport_clocks (framepos_t pos);
376 void record_state_changed ();
378 std::list<MidiTracer*> _midi_tracer_windows;
380 /* Transport Control */
382 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
383 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
385 Gtkmm2ext::TearOff* transport_tearoff;
386 Gtk::Frame transport_frame;
387 Gtk::HBox transport_tearoff_hbox;
388 Gtk::HBox _editor_transport_box;
389 Gtk::HBox transport_hbox;
390 Gtk::Fixed transport_base;
391 Gtk::Fixed transport_button_base;
392 Gtk::Frame transport_button_frame;
393 Gtk::HBox transport_button_hbox;
394 Gtk::VBox transport_button_vbox;
395 Gtk::HBox transport_option_button_hbox;
396 Gtk::VBox transport_option_button_vbox;
397 Gtk::HBox transport_clock_hbox;
398 Gtk::VBox transport_clock_vbox;
399 Gtk::HBox primary_clock_hbox;
400 Gtk::HBox secondary_clock_hbox;
402 struct TransportControllable : public PBD::Controllable {
413 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
414 void set_value (double);
415 double get_value (void) const;
421 boost::shared_ptr<TransportControllable> roll_controllable;
422 boost::shared_ptr<TransportControllable> stop_controllable;
423 boost::shared_ptr<TransportControllable> goto_start_controllable;
424 boost::shared_ptr<TransportControllable> goto_end_controllable;
425 boost::shared_ptr<TransportControllable> auto_loop_controllable;
426 boost::shared_ptr<TransportControllable> play_selection_controllable;
427 boost::shared_ptr<TransportControllable> rec_controllable;
429 void toggle_follow_edits ();
431 void set_transport_controllable_state (const XMLNode&);
432 XMLNode& get_transport_controllable_state ();
434 ArdourButton roll_button;
435 ArdourButton stop_button;
436 ArdourButton goto_start_button;
437 ArdourButton goto_end_button;
438 ArdourButton auto_loop_button;
439 ArdourButton play_selection_button;
440 ArdourButton rec_button;
442 void toggle_external_sync ();
443 void toggle_time_master ();
444 void toggle_video_sync ();
446 ShuttleControl* shuttle_box;
448 ArdourButton auto_return_button;
449 ArdourButton follow_edits_button;
450 ArdourButton auto_input_button;
451 ArdourButton click_button;
452 ArdourButton sync_button;
454 ArdourButton auditioning_alert_button;
455 ArdourButton solo_alert_button;
456 ArdourButton feedback_alert_button;
460 LevelMeterHBox * editor_meter;
461 float editor_meter_max_peak;
462 ArdourButton editor_meter_peak_display;
463 bool editor_meter_peak_button_release (GdkEventButton*);
465 void solo_blink (bool);
466 void sync_blink (bool);
467 void audition_blink (bool);
468 void feedback_blink (bool);
470 void soloing_changed (bool);
471 void auditioning_changed (bool);
472 void _auditioning_changed (bool);
474 bool solo_alert_press (GdkEventButton* ev);
475 bool audition_alert_press (GdkEventButton* ev);
476 bool feedback_alert_press (GdkEventButton *);
478 void big_clock_value_changed ();
479 void primary_clock_value_changed ();
480 void secondary_clock_value_changed ();
482 /* called by Blink signal */
484 void transport_rec_enable_blink (bool onoff);
486 Gtk::Menu* session_popup_menu;
488 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
489 RecentSessionModelColumns() {
494 Gtk::TreeModelColumn<std::string> visible_name;
495 Gtk::TreeModelColumn<std::string> tip;
496 Gtk::TreeModelColumn<std::string> fullpath;
499 RecentSessionModelColumns recent_session_columns;
500 Gtk::TreeView recent_session_display;
501 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
503 ArdourDialog* session_selector_window;
504 Gtk::FileChooserDialog* open_session_selector;
506 void build_session_selector();
507 void redisplay_recent_sessions();
508 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
510 struct RecentSessionsSorter {
511 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
512 return ARDOUR::cmp_nocase(a.first, b.first) == -1;
516 /* menu bar and associated stuff */
518 Gtk::MenuBar* menu_bar;
519 Gtk::EventBox menu_bar_base;
522 void use_menubar_as_top_menubar ();
523 void build_menu_bar ();
525 Gtk::Label wall_clock_label;
526 gint update_wall_clock ();
528 Gtk::Label disk_space_label;
529 void update_disk_space ();
531 Gtk::Label timecode_format_label;
532 void update_timecode_format ();
534 Gtk::Label cpu_load_label;
535 void update_cpu_load ();
537 Gtk::Label buffer_load_label;
538 void update_buffer_load ();
540 Gtk::Label sample_rate_label;
541 void update_sample_rate (ARDOUR::framecnt_t);
543 Gtk::Label format_label;
544 void update_format ();
546 gint every_second ();
547 gint every_point_one_seconds ();
548 gint every_point_zero_something_seconds ();
550 sigc::connection second_connection;
551 sigc::connection point_one_second_connection;
552 sigc::connection point_zero_something_second_connection;
554 void open_session ();
555 void open_recent_session ();
556 void save_template ();
558 void edit_metadata ();
559 void import_metadata ();
561 void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
562 void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &, ARDOUR::PluginInfoPtr);
564 void set_transport_sensitivity (bool);
566 //stuff for ProTools-style numpad
567 void transport_numpad_event (int num);
568 void transport_numpad_decimal ();
569 bool _numpad_locate_happening;
570 int _pending_locate_num;
571 gint transport_numpad_timeout ();
572 sigc::connection _numpad_timeout_connection;
574 void transport_goto_nth_marker (int nth);
575 void transport_goto_zero ();
576 void transport_goto_start ();
577 void transport_goto_end ();
578 void transport_goto_wallclock ();
579 void transport_stop ();
580 void transport_record (bool roll);
581 void transport_roll ();
582 void transport_play_selection();
583 void transport_play_preroll();
584 void transport_forward (int option);
585 void transport_rewind (int option);
586 void transport_loop ();
587 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
588 bool trx_record_enable_all_tracks ();
590 bool _session_is_new;
591 void set_session (ARDOUR::Session *);
592 void connect_dependents_to_session (ARDOUR::Session *);
593 void we_have_dependents ();
595 void setup_session_options ();
597 guint32 last_key_press_time;
599 void snapshot_session (bool switch_to_it);
600 void rename_session ();
601 void setup_order_hint ();
606 PublicEditor *editor;
607 int create_editor ();
609 Meterbridge *meterbridge;
610 int create_meterbridge ();
611 /* Dialogs that can be created via new<T> */
613 WM::Proxy<SpeakerDialog> speaker_config_window;
614 WM::Proxy<ThemeManager> theme_manager;
615 WM::Proxy<KeyEditor> key_editor;
616 WM::Proxy<RCOptionEditor> rc_option_editor;
617 WM::Proxy<AddRouteDialog> add_route_dialog;
618 WM::Proxy<About> about;
619 WM::Proxy<LocationUIWindow> location_ui;
620 WM::Proxy<RouteParams_UI> route_params;
621 WM::Proxy<EngineControl> audio_midi_setup;
623 /* Windows/Dialogs that require a creator method */
625 WM::ProxyWithConstructor<SessionOptionEditor> session_option_editor;
626 WM::ProxyWithConstructor<AddVideoDialog> add_video_dialog;
627 WM::ProxyWithConstructor<BundleManager> bundle_manager;
628 WM::ProxyWithConstructor<BigClockWindow> big_clock_window;
629 WM::ProxyWithConstructor<GlobalPortMatrixWindow> audio_port_matrix;
630 WM::ProxyWithConstructor<GlobalPortMatrixWindow> midi_port_matrix;
632 /* creator methods */
634 SessionOptionEditor* create_session_option_editor ();
635 BundleManager* create_bundle_manager ();
636 AddVideoDialog* create_add_video_dialog ();
637 BigClockWindow* create_big_clock_window();
638 GlobalPortMatrixWindow* create_global_port_matrix (ARDOUR::DataType);
640 static UIConfiguration *ui_config;
642 ARDOUR::SystemExec *video_server_process;
644 void handle_locations_change (ARDOUR::Location*);
646 /* Keyboard Handling */
648 ArdourKeyboard* keyboard;
650 /* Keymap handling */
652 void install_actions ();
654 void toggle_record_enable (uint32_t);
656 uint32_t rec_enabled_streams;
657 void count_recenabled_streams (ARDOUR::Route&);
661 void pop_back_splash (Gtk::Window&);
665 Gtk::MenuItem *cleanup_item;
667 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete);
671 bool have_configure_timeout;
672 ARDOUR::microseconds_t last_configure_time;
673 gint configure_timeout ();
675 ARDOUR::microseconds_t last_peak_grab;
676 ARDOUR::microseconds_t last_shuttle_request;
678 bool have_disk_speed_dialog_displayed;
679 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
680 void disk_overrun_handler ();
681 void disk_underrun_handler ();
682 void gui_idle_handler ();
684 void cancel_plugin_scan ();
685 void cancel_plugin_timeout ();
686 void plugin_scan_dialog (std::string type, std::string plugin, bool);
687 void plugin_scan_timeout (int);
689 void session_format_mismatch (std::string, std::string);
691 void session_dialog (std::string);
692 int pending_state_dialog ();
693 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
695 Gtk::MenuItem* jack_disconnect_item;
696 Gtk::MenuItem* jack_reconnect_item;
697 Gtk::Menu* jack_bufsize_menu;
699 Glib::RefPtr<Gtk::ActionGroup> common_actions;
701 void editor_realized ();
703 std::vector<std::string> positional_sync_strings;
705 void toggle_send_midi_feedback ();
706 void toggle_use_mmc ();
707 void toggle_send_mmc ();
708 void toggle_send_mtc ();
709 void toggle_send_midi_clock ();
711 void toggle_use_osc ();
713 void parameter_changed (std::string);
714 void session_parameter_changed (std::string);
718 void check_memory_locking ();
720 bool check_audioengine();
721 void audioengine_setup ();
723 void display_message (const char *prefix, gint prefix_len,
724 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
726 Gtk::Label status_bar_label;
727 bool status_bar_button_press (GdkEventButton*);
728 Gtk::ToggleButton error_log_button;
730 void loading_message (const std::string& msg);
732 PBD::ScopedConnectionList forever_connections;
733 PBD::ScopedConnection halt_connection;
735 void step_edit_status_change (bool);
737 void platform_specific ();
738 void platform_setup ();
740 /* these are used only in response to a platform-specific "ShouldQuit" signal
743 void queue_finish ();
744 void fontconfig_dialog ();
746 int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
747 int ambiguous_file (std::string file, std::vector<std::string> hits);
749 bool click_button_clicked (GdkEventButton *);
751 VisibilityGroup _status_bar_visibility;
753 /** A ProcessThread so that we have some thread-local buffers for use by
754 * PluginEqGui::impulse_analysis ().
756 ARDOUR::ProcessThread* _process_thread;
758 void feedback_detected ();
760 ArdourButton midi_panic_button;
763 void successful_graph_sort ();
764 bool _feedback_exists;
766 void resize_text_widgets ();
768 std::string _announce_string;
769 void check_announcements ();
771 int do_audio_midi_setup (uint32_t);
774 #endif /* __ardour_gui_h__ */