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 /** every_fps -- see set_fps_timeout_connection() 25Hz < x < 120Hz */
194 static sigc::signal<void> FPSUpdate;
196 /** Emitted frequently with the audible frame, false, and the edit point as
197 * parameters respectively.
199 * (either RapidScreenUpdate || SuperRapidScreenUpdate - user-config)
201 static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
203 static void close_all_dialogs () { CloseAllDialogs(); }
204 static sigc::signal<void> CloseAllDialogs;
206 XMLNode* editor_settings() const;
207 XMLNode* mixer_settings () const;
208 XMLNode* keyboard_settings () const;
209 XMLNode* tearoff_settings (const char*) const;
211 void save_ardour_state ();
212 gboolean configure_handler (GdkEventConfigure* conf);
214 void halt_on_xrun_message ();
215 void xrun_handler (framepos_t);
216 void create_xrun_marker (framepos_t);
218 GUIObjectState* gui_object_state;
220 MainClock* primary_clock;
221 MainClock* secondary_clock;
222 void focus_on_clock ();
223 AudioClock* big_clock;
225 TimeInfoBox* time_info_box;
227 VideoTimeLine *video_timeline;
229 void store_clock_modes ();
230 void restore_clock_modes ();
231 void reset_main_clocks ();
233 void synchronize_sync_source_and_video_pullup ();
235 void add_route (Gtk::Window* float_window);
236 void add_routes_part_two ();
237 void add_routes_thread ();
239 void add_video (Gtk::Window* float_window);
240 void remove_video ();
241 void start_video_server_menu (Gtk::Window* float_window);
242 bool start_video_server (Gtk::Window* float_window, bool popup_msg);
243 void stop_video_server (bool ask_confirm=false);
244 void flush_videotimeline_cache (bool localcacheonly=false);
246 void session_add_audio_track (
248 int32_t output_channels,
249 ARDOUR::TrackMode mode,
250 ARDOUR::RouteGroup* route_group,
252 std::string const & name_template
255 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
258 void session_add_audio_bus (int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group,
259 uint32_t how_many, std::string const & name_template) {
260 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
263 void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many, std::string const & name_template,
264 ARDOUR::PluginInfoPtr instrument) {
265 session_add_midi_route (true, route_group, how_many, name_template, instrument);
268 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,
269 ARDOUR::PluginInfoPtr instrument);
271 /*void session_add_midi_bus () {
272 session_add_midi_route (false);
275 void attach_to_engine ();
278 gint exit_on_main_window_close (GdkEventAny *);
280 void maximise_editing_space ();
281 void restore_editing_space ();
283 void show_ui_prefs ();
285 void update_tearoff_visibility ();
287 void setup_profile ();
288 void setup_tooltips ();
290 void set_shuttle_fract (double);
292 void get_process_buffers ();
293 void drop_process_buffers ();
295 void reset_peak_display ();
296 void reset_route_peak_display (ARDOUR::Route*);
297 void reset_group_peak_display (ARDOUR::RouteGroup*);
299 const std::string& announce_string() const { return _announce_string; }
301 int disconnect_from_engine ();
302 int reconnect_to_engine ();
305 friend class PublicEditor;
307 void toggle_auto_play ();
308 void toggle_auto_input ();
309 void toggle_punch ();
310 void unset_dual_punch ();
311 bool ignore_dual_punch;
312 void toggle_punch_in ();
313 void toggle_punch_out ();
314 void show_loop_punch_ruler_and_disallow_hide ();
315 void reenable_hide_loop_punch_ruler_if_appropriate ();
316 void toggle_auto_return ();
317 void toggle_click ();
318 void toggle_audio_midi_setup ();
319 void toggle_session_auto_loop ();
320 void toggle_rc_options_window ();
321 void toggle_session_options_window ();
324 Gtk::Tooltips _tooltips;
328 bool first_time_engine_run;
330 void goto_editor_window ();
331 void goto_mixer_window ();
332 void toggle_mixer_window ();
333 void toggle_meterbridge ();
334 void toggle_editor_mixer ();
336 int setup_windows ();
337 void setup_transport ();
340 static ARDOUR_UI *theArdourUI;
344 int ask_about_saving_session (const std::vector<std::string>& actions);
346 /* periodic safety backup, to be precise */
347 gint autosave_session();
348 void update_autosave();
349 sigc::connection _autosave_connection;
351 void map_transport_state ();
352 int32_t do_engine_start ();
354 void engine_halted (const char* reason, bool free_reason);
355 void engine_stopped ();
356 void engine_running ();
360 static gint _blink (void *);
362 gint blink_timeout_tag;
364 void start_blinking ();
365 void stop_blinking ();
367 void about_signal_response(int response);
369 Gtk::VBox top_packer;
371 sigc::connection clock_signal_connection;
372 void update_clocks ();
373 void start_clocking ();
374 void stop_clocking ();
376 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
378 void update_transport_clocks (framepos_t pos);
379 void record_state_changed ();
381 std::list<MidiTracer*> _midi_tracer_windows;
383 /* Transport Control */
385 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
386 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
388 Gtkmm2ext::TearOff* transport_tearoff;
389 Gtk::Frame transport_frame;
390 Gtk::HBox transport_tearoff_hbox;
391 Gtk::HBox _editor_transport_box;
392 Gtk::HBox transport_hbox;
393 Gtk::Fixed transport_base;
394 Gtk::Fixed transport_button_base;
395 Gtk::Frame transport_button_frame;
396 Gtk::HBox transport_button_hbox;
397 Gtk::VBox transport_button_vbox;
398 Gtk::HBox transport_option_button_hbox;
399 Gtk::VBox transport_option_button_vbox;
400 Gtk::HBox transport_clock_hbox;
401 Gtk::VBox transport_clock_vbox;
402 Gtk::HBox primary_clock_hbox;
403 Gtk::HBox secondary_clock_hbox;
405 struct TransportControllable : public PBD::Controllable {
416 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
417 void set_value (double);
418 double get_value (void) const;
424 boost::shared_ptr<TransportControllable> roll_controllable;
425 boost::shared_ptr<TransportControllable> stop_controllable;
426 boost::shared_ptr<TransportControllable> goto_start_controllable;
427 boost::shared_ptr<TransportControllable> goto_end_controllable;
428 boost::shared_ptr<TransportControllable> auto_loop_controllable;
429 boost::shared_ptr<TransportControllable> play_selection_controllable;
430 boost::shared_ptr<TransportControllable> rec_controllable;
432 void toggle_follow_edits ();
434 void set_transport_controllable_state (const XMLNode&);
435 XMLNode& get_transport_controllable_state ();
437 ArdourButton roll_button;
438 ArdourButton stop_button;
439 ArdourButton goto_start_button;
440 ArdourButton goto_end_button;
441 ArdourButton auto_loop_button;
442 ArdourButton play_selection_button;
443 ArdourButton rec_button;
445 void toggle_external_sync ();
446 void toggle_time_master ();
447 void toggle_video_sync ();
449 ShuttleControl* shuttle_box;
451 ArdourButton auto_return_button;
452 ArdourButton follow_edits_button;
453 ArdourButton auto_input_button;
454 ArdourButton click_button;
455 ArdourButton sync_button;
457 ArdourButton auditioning_alert_button;
458 ArdourButton solo_alert_button;
459 ArdourButton feedback_alert_button;
463 LevelMeterHBox * editor_meter;
464 float editor_meter_max_peak;
465 ArdourButton editor_meter_peak_display;
466 bool editor_meter_peak_button_release (GdkEventButton*);
468 void solo_blink (bool);
469 void sync_blink (bool);
470 void audition_blink (bool);
471 void feedback_blink (bool);
473 void set_flat_buttons();
475 void soloing_changed (bool);
476 void auditioning_changed (bool);
477 void _auditioning_changed (bool);
479 bool solo_alert_press (GdkEventButton* ev);
480 bool audition_alert_press (GdkEventButton* ev);
481 bool feedback_alert_press (GdkEventButton *);
483 void big_clock_value_changed ();
484 void primary_clock_value_changed ();
485 void secondary_clock_value_changed ();
487 /* called by Blink signal */
489 void transport_rec_enable_blink (bool onoff);
491 Gtk::Menu* session_popup_menu;
493 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
494 RecentSessionModelColumns() {
499 Gtk::TreeModelColumn<std::string> visible_name;
500 Gtk::TreeModelColumn<std::string> tip;
501 Gtk::TreeModelColumn<std::string> fullpath;
504 RecentSessionModelColumns recent_session_columns;
505 Gtk::TreeView recent_session_display;
506 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
508 ArdourDialog* session_selector_window;
509 Gtk::FileChooserDialog* open_session_selector;
511 void build_session_selector();
512 void redisplay_recent_sessions();
513 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
515 struct RecentSessionsSorter {
516 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
517 return ARDOUR::cmp_nocase(a.first, b.first) == -1;
521 /* menu bar and associated stuff */
523 Gtk::MenuBar* menu_bar;
524 Gtk::EventBox menu_bar_base;
527 void use_menubar_as_top_menubar ();
528 void build_menu_bar ();
530 Gtk::Label wall_clock_label;
531 gint update_wall_clock ();
533 Gtk::Label disk_space_label;
534 void update_disk_space ();
536 Gtk::Label timecode_format_label;
537 void update_timecode_format ();
539 Gtk::Label cpu_load_label;
540 void update_cpu_load ();
542 Gtk::Label buffer_load_label;
543 void update_buffer_load ();
545 Gtk::Label sample_rate_label;
546 void update_sample_rate (ARDOUR::framecnt_t);
548 Gtk::Label format_label;
549 void update_format ();
551 gint every_second ();
552 gint every_point_one_seconds ();
553 gint every_point_zero_something_seconds ();
556 sigc::connection second_connection;
557 sigc::connection point_one_second_connection;
558 sigc::connection point_zero_something_second_connection;
559 sigc::connection fps_connection;
561 void set_fps_timeout_connection ();
563 void open_session ();
564 void open_recent_session ();
565 void save_template ();
567 void edit_metadata ();
568 void import_metadata ();
570 void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
571 void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &, ARDOUR::PluginInfoPtr);
573 void set_transport_sensitivity (bool);
575 //stuff for ProTools-style numpad
576 void transport_numpad_event (int num);
577 void transport_numpad_decimal ();
578 bool _numpad_locate_happening;
579 int _pending_locate_num;
580 gint transport_numpad_timeout ();
581 sigc::connection _numpad_timeout_connection;
583 void transport_goto_nth_marker (int nth);
584 void transport_goto_zero ();
585 void transport_goto_start ();
586 void transport_goto_end ();
587 void transport_goto_wallclock ();
588 void transport_stop ();
589 void transport_record (bool roll);
590 void transport_roll ();
591 void transport_play_selection();
592 void transport_play_preroll();
593 void transport_forward (int option);
594 void transport_rewind (int option);
595 void transport_loop ();
596 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
597 bool trx_record_enable_all_tracks ();
599 bool _session_is_new;
600 void set_session (ARDOUR::Session *);
601 void connect_dependents_to_session (ARDOUR::Session *);
602 void we_have_dependents ();
604 void setup_session_options ();
606 guint32 last_key_press_time;
608 void snapshot_session (bool switch_to_it);
609 void rename_session ();
610 void setup_order_hint ();
615 PublicEditor *editor;
616 int create_editor ();
618 Meterbridge *meterbridge;
619 int create_meterbridge ();
620 /* Dialogs that can be created via new<T> */
622 WM::Proxy<SpeakerDialog> speaker_config_window;
623 WM::Proxy<ThemeManager> theme_manager;
624 WM::Proxy<KeyEditor> key_editor;
625 WM::Proxy<RCOptionEditor> rc_option_editor;
626 WM::Proxy<AddRouteDialog> add_route_dialog;
627 WM::Proxy<About> about;
628 WM::Proxy<LocationUIWindow> location_ui;
629 WM::Proxy<RouteParams_UI> route_params;
630 WM::Proxy<EngineControl> audio_midi_setup;
632 /* Windows/Dialogs that require a creator method */
634 WM::ProxyWithConstructor<SessionOptionEditor> session_option_editor;
635 WM::ProxyWithConstructor<AddVideoDialog> add_video_dialog;
636 WM::ProxyWithConstructor<BundleManager> bundle_manager;
637 WM::ProxyWithConstructor<BigClockWindow> big_clock_window;
638 WM::ProxyWithConstructor<GlobalPortMatrixWindow> audio_port_matrix;
639 WM::ProxyWithConstructor<GlobalPortMatrixWindow> midi_port_matrix;
641 /* creator methods */
643 SessionOptionEditor* create_session_option_editor ();
644 BundleManager* create_bundle_manager ();
645 AddVideoDialog* create_add_video_dialog ();
646 BigClockWindow* create_big_clock_window();
647 GlobalPortMatrixWindow* create_global_port_matrix (ARDOUR::DataType);
649 static UIConfiguration *ui_config;
651 ARDOUR::SystemExec *video_server_process;
653 void handle_locations_change (ARDOUR::Location*);
655 /* Keyboard Handling */
657 ArdourKeyboard* keyboard;
659 /* Keymap handling */
661 void install_actions ();
663 void toggle_record_enable (uint32_t);
665 uint32_t rec_enabled_streams;
666 void count_recenabled_streams (ARDOUR::Route&);
670 void pop_back_splash (Gtk::Window&);
674 Gtk::MenuItem *cleanup_item;
676 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete);
680 bool have_configure_timeout;
681 ARDOUR::microseconds_t last_configure_time;
682 gint configure_timeout ();
684 ARDOUR::microseconds_t last_peak_grab;
685 ARDOUR::microseconds_t last_shuttle_request;
687 bool have_disk_speed_dialog_displayed;
688 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
689 void disk_overrun_handler ();
690 void disk_underrun_handler ();
691 void gui_idle_handler ();
693 void cancel_plugin_scan ();
694 void cancel_plugin_timeout ();
695 void plugin_scan_dialog (std::string type, std::string plugin, bool);
696 void plugin_scan_timeout (int);
698 void session_format_mismatch (std::string, std::string);
700 void session_dialog (std::string);
701 int pending_state_dialog ();
702 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
704 Gtk::MenuItem* jack_disconnect_item;
705 Gtk::MenuItem* jack_reconnect_item;
706 Gtk::Menu* jack_bufsize_menu;
708 Glib::RefPtr<Gtk::ActionGroup> common_actions;
710 void editor_realized ();
712 std::vector<std::string> positional_sync_strings;
714 void toggle_send_midi_feedback ();
715 void toggle_use_mmc ();
716 void toggle_send_mmc ();
717 void toggle_send_mtc ();
718 void toggle_send_midi_clock ();
720 void toggle_use_osc ();
722 void parameter_changed (std::string);
723 void session_parameter_changed (std::string);
727 void check_memory_locking ();
729 bool check_audioengine();
730 void audioengine_setup ();
732 void display_message (const char *prefix, gint prefix_len,
733 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
735 Gtk::Label status_bar_label;
736 bool status_bar_button_press (GdkEventButton*);
737 Gtk::ToggleButton error_log_button;
739 void loading_message (const std::string& msg);
741 PBD::ScopedConnectionList forever_connections;
742 PBD::ScopedConnection halt_connection;
744 void step_edit_status_change (bool);
746 void platform_specific ();
747 void platform_setup ();
749 /* these are used only in response to a platform-specific "ShouldQuit" signal
752 void queue_finish ();
753 void fontconfig_dialog ();
755 int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
756 int ambiguous_file (std::string file, std::vector<std::string> hits);
758 bool click_button_clicked (GdkEventButton *);
760 VisibilityGroup _status_bar_visibility;
762 /** A ProcessThread so that we have some thread-local buffers for use by
763 * PluginEqGui::impulse_analysis ().
765 ARDOUR::ProcessThread* _process_thread;
767 void feedback_detected ();
769 ArdourButton midi_panic_button;
772 void successful_graph_sort ();
773 bool _feedback_exists;
775 void resize_text_widgets ();
777 std::string _announce_string;
778 void check_announcements ();
780 int do_audio_midi_setup (uint32_t);
783 #endif /* __ardour_gui_h__ */