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 */
38 #include <libgnomecanvasmm/canvas.h>
40 #include "pbd/xml++.h"
41 #include "pbd/controllable.h"
42 #include <gtkmm/box.h>
43 #include <gtkmm/frame.h>
44 #include <gtkmm/label.h>
45 #include <gtkmm/table.h>
46 #include <gtkmm/fixed.h>
47 #include <gtkmm/drawingarea.h>
48 #include <gtkmm/eventbox.h>
49 #include <gtkmm/menu.h>
50 #include <gtkmm/menuitem.h>
51 #include <gtkmm/button.h>
52 #include <gtkmm/togglebutton.h>
53 #include <gtkmm/treeview.h>
54 #include <gtkmm/menubar.h>
55 #include <gtkmm/textbuffer.h>
56 #include <gtkmm/adjustment.h>
57 #include <gtkmm2ext/gtk_ui.h>
58 #include <gtkmm2ext/click_box.h>
59 #include <gtkmm2ext/stateful_button.h>
60 #include <gtkmm2ext/bindable_button.h>
62 #include "ardour/ardour.h"
63 #include "ardour/types.h"
64 #include "ardour/utils.h"
65 #include "ardour/plugin.h"
66 #include "ardour/session_handle.h"
68 #include "video_timeline.h"
70 #include "ardour_button.h"
71 #include "ardour_dialog.h"
72 #include "ardour_window.h"
74 #include "meterbridge.h"
76 #include "ui_config.h"
78 #include "visibility_group.h"
79 #include "window_manager.h"
92 class ConnectionEditor;
95 class LocationUIWindow;
100 class RouteParams_UI;
101 class SessionOptionEditor;
102 class ShuttleControl;
108 class LevelMeterHBox;
109 class GlobalPortMatrixWindow;
110 class GUIObjectState;
112 namespace Gtkmm2ext {
117 class ControlProtocolInfo;
126 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
129 ARDOUR_UI (int *argcp, char **argvp[], const char* localedir);
132 bool run_startup (bool should_be_new, std::string load_template);
138 void launch_manual ();
139 void launch_reference ();
143 void idle_load (const std::string& path);
146 int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
148 int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
149 bool session_is_new() const { return _session_is_new; }
151 ARDOUR::Session* the_session() { return _session; }
153 bool get_smart_mode () const;
155 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
156 int build_session_from_nsd (const std::string& session_name, const std::string& session_path);
157 bool ask_about_loading_existing_session (const std::string& session_path);
159 /// @return true if session was successfully unloaded.
160 int unload_session (bool hide_stuff = false);
161 void close_session();
163 int save_state_canfail (std::string state_name = "", bool switch_to_it = false);
164 void save_state (const std::string & state_name = "", bool switch_to_it = false);
166 static ARDOUR_UI *instance () { return theArdourUI; }
167 static UIConfiguration *config () { return ui_config; }
169 PublicEditor& the_editor(){return *editor;}
170 Mixer_UI* the_mixer() { return mixer; }
172 void new_midi_tracer_window ();
173 void toggle_editing_space();
174 void toggle_keep_tearoffs();
176 Gtk::Tooltips& tooltips() { return _tooltips; }
178 Gtk::HBox& editor_transport_box() { return _editor_transport_box; }
180 static PublicEditor* _instance;
181 static sigc::signal<void,bool> Blink;
183 /** point_zero_one_seconds -- 10Hz ^= 100ms */
184 static sigc::signal<void> RapidScreenUpdate;
186 /** point_zero_something_seconds -- currently 25Hz ^= 40ms */
187 static sigc::signal<void> SuperRapidScreenUpdate;
189 /** Emitted frequently with the audible frame, false, and the edit point as
190 * parameters respectively.
192 * (either RapidScreenUpdate || SuperRapidScreenUpdate - user-config)
194 static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
196 static void close_all_dialogs () { CloseAllDialogs(); }
197 static sigc::signal<void> CloseAllDialogs;
199 XMLNode* editor_settings() const;
200 XMLNode* mixer_settings () const;
201 XMLNode* keyboard_settings () const;
202 XMLNode* tearoff_settings (const char*) const;
204 void save_ardour_state ();
205 gboolean configure_handler (GdkEventConfigure* conf);
207 void halt_on_xrun_message ();
208 void xrun_handler (framepos_t);
209 void create_xrun_marker (framepos_t);
211 GUIObjectState* gui_object_state;
213 MainClock* primary_clock;
214 MainClock* secondary_clock;
215 void focus_on_clock ();
216 AudioClock* big_clock;
218 TimeInfoBox* time_info_box;
220 VideoTimeLine *video_timeline;
222 void store_clock_modes ();
223 void restore_clock_modes ();
224 void reset_main_clocks ();
226 void synchronize_sync_source_and_video_pullup ();
228 void add_route (Gtk::Window* float_window);
229 void add_routes_part_two ();
230 void add_routes_thread ();
232 void add_video (Gtk::Window* float_window);
233 void remove_video ();
234 void start_video_server_menu (Gtk::Window* float_window);
235 bool start_video_server (Gtk::Window* float_window, bool popup_msg);
236 void stop_video_server (bool ask_confirm=false);
237 void flush_videotimeline_cache (bool localcacheonly=false);
239 void session_add_audio_track (
241 int32_t output_channels,
242 ARDOUR::TrackMode mode,
243 ARDOUR::RouteGroup* route_group,
245 std::string const & name_template
248 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
251 void session_add_audio_bus (int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group,
252 uint32_t how_many, std::string const & name_template) {
253 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
256 void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many, std::string const & name_template,
257 ARDOUR::PluginInfoPtr instrument) {
258 session_add_midi_route (true, route_group, how_many, name_template, instrument);
261 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,
262 ARDOUR::PluginInfoPtr instrument);
264 /*void session_add_midi_bus () {
265 session_add_midi_route (false);
268 void attach_to_engine ();
271 gint exit_on_main_window_close (GdkEventAny *);
273 void maximise_editing_space ();
274 void restore_editing_space ();
276 void update_tearoff_visibility ();
278 void setup_profile ();
279 void setup_tooltips ();
281 void set_shuttle_fract (double);
283 void get_process_buffers ();
284 void drop_process_buffers ();
286 void reset_peak_display ();
287 void reset_route_peak_display (ARDOUR::Route*);
288 void reset_group_peak_display (ARDOUR::RouteGroup*);
290 const std::string& announce_string() const { return _announce_string; }
293 friend class PublicEditor;
295 void toggle_auto_play ();
296 void toggle_auto_input ();
297 void toggle_punch ();
298 void unset_dual_punch ();
299 bool ignore_dual_punch;
300 void toggle_punch_in ();
301 void toggle_punch_out ();
302 void show_loop_punch_ruler_and_disallow_hide ();
303 void reenable_hide_loop_punch_ruler_if_appropriate ();
304 void toggle_auto_return ();
305 void toggle_click ();
306 void toggle_audio_midi_setup ();
307 void toggle_session_auto_loop ();
308 void toggle_rc_options_window ();
309 void toggle_session_options_window ();
312 ArdourStartup* _startup;
313 Gtk::Tooltips _tooltips;
317 bool first_time_engine_run;
319 void goto_editor_window ();
320 void goto_mixer_window ();
321 void toggle_mixer_window ();
322 void toggle_meterbridge ();
323 void toggle_editor_mixer ();
325 int setup_windows ();
326 void setup_transport ();
329 static ARDOUR_UI *theArdourUI;
334 int ask_about_saving_session (const std::vector<std::string>& actions);
336 /* periodic safety backup, to be precise */
337 gint autosave_session();
338 void update_autosave();
339 sigc::connection _autosave_connection;
341 void map_transport_state ();
342 int32_t do_engine_start ();
344 void engine_halted (const char* reason, bool free_reason);
345 void engine_stopped ();
346 void engine_running ();
350 static gint _blink (void *);
352 gint blink_timeout_tag;
354 void start_blinking ();
355 void stop_blinking ();
357 void about_signal_response(int response);
359 Gtk::VBox top_packer;
361 sigc::connection clock_signal_connection;
362 void update_clocks ();
363 void start_clocking ();
364 void stop_clocking ();
366 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
368 void update_transport_clocks (framepos_t pos);
369 void record_state_changed ();
371 std::list<MidiTracer*> _midi_tracer_windows;
373 /* Transport Control */
375 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
376 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
378 Gtkmm2ext::TearOff* transport_tearoff;
379 Gtk::Frame transport_frame;
380 Gtk::HBox transport_tearoff_hbox;
381 Gtk::HBox _editor_transport_box;
382 Gtk::HBox transport_hbox;
383 Gtk::Fixed transport_base;
384 Gtk::Fixed transport_button_base;
385 Gtk::Frame transport_button_frame;
386 Gtk::HBox transport_button_hbox;
387 Gtk::VBox transport_button_vbox;
388 Gtk::HBox transport_option_button_hbox;
389 Gtk::VBox transport_option_button_vbox;
390 Gtk::HBox transport_clock_hbox;
391 Gtk::VBox transport_clock_vbox;
392 Gtk::HBox primary_clock_hbox;
393 Gtk::HBox secondary_clock_hbox;
395 struct TransportControllable : public PBD::Controllable {
406 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
407 void set_value (double);
408 double get_value (void) const;
414 boost::shared_ptr<TransportControllable> roll_controllable;
415 boost::shared_ptr<TransportControllable> stop_controllable;
416 boost::shared_ptr<TransportControllable> goto_start_controllable;
417 boost::shared_ptr<TransportControllable> goto_end_controllable;
418 boost::shared_ptr<TransportControllable> auto_loop_controllable;
419 boost::shared_ptr<TransportControllable> play_selection_controllable;
420 boost::shared_ptr<TransportControllable> rec_controllable;
422 void toggle_always_play_range ();
424 void set_transport_controllable_state (const XMLNode&);
425 XMLNode& get_transport_controllable_state ();
427 ArdourButton roll_button;
428 ArdourButton stop_button;
429 ArdourButton goto_start_button;
430 ArdourButton goto_end_button;
431 ArdourButton auto_loop_button;
432 ArdourButton play_selection_button;
433 ArdourButton rec_button;
435 void toggle_external_sync ();
436 void toggle_time_master ();
437 void toggle_video_sync ();
439 ShuttleControl* shuttle_box;
441 ArdourButton auto_return_button;
442 ArdourButton follow_edits_button;
443 ArdourButton auto_input_button;
444 ArdourButton click_button;
445 ArdourButton sync_button;
447 ArdourButton auditioning_alert_button;
448 ArdourButton solo_alert_button;
449 ArdourButton feedback_alert_button;
453 LevelMeterHBox * editor_meter;
454 float editor_meter_max_peak;
455 ArdourButton editor_meter_peak_display;
456 bool editor_meter_peak_button_release (GdkEventButton*);
458 void solo_blink (bool);
459 void sync_blink (bool);
460 void audition_blink (bool);
461 void feedback_blink (bool);
463 void soloing_changed (bool);
464 void auditioning_changed (bool);
465 void _auditioning_changed (bool);
467 bool solo_alert_press (GdkEventButton* ev);
468 bool audition_alert_press (GdkEventButton* ev);
469 bool feedback_alert_press (GdkEventButton *);
471 void big_clock_value_changed ();
472 void primary_clock_value_changed ();
473 void secondary_clock_value_changed ();
475 /* called by Blink signal */
477 void transport_rec_enable_blink (bool onoff);
479 Gtk::Menu* session_popup_menu;
481 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
482 RecentSessionModelColumns() {
487 Gtk::TreeModelColumn<std::string> visible_name;
488 Gtk::TreeModelColumn<std::string> tip;
489 Gtk::TreeModelColumn<std::string> 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<std::string,std::string> a, std::pair<std::string,std::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;
515 void use_menubar_as_top_menubar ();
516 void build_menu_bar ();
518 Gtk::Label wall_clock_label;
519 gint update_wall_clock ();
521 Gtk::Label disk_space_label;
522 void update_disk_space ();
524 Gtk::Label timecode_format_label;
525 void update_timecode_format ();
527 Gtk::Label cpu_load_label;
528 void update_cpu_load ();
530 Gtk::Label buffer_load_label;
531 void update_buffer_load ();
533 Gtk::Label sample_rate_label;
534 void update_sample_rate (ARDOUR::framecnt_t);
536 Gtk::Label format_label;
537 void update_format ();
539 gint every_second ();
540 gint every_point_one_seconds ();
541 gint every_point_zero_something_seconds ();
543 sigc::connection second_connection;
544 sigc::connection point_one_second_connection;
545 sigc::connection point_zero_something_second_connection;
547 void open_session ();
548 void open_recent_session ();
549 void save_template ();
551 void edit_metadata ();
552 void import_metadata ();
554 void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
555 void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &, ARDOUR::PluginInfoPtr);
557 void set_transport_sensitivity (bool);
559 void transport_goto_zero ();
560 void transport_goto_start ();
561 void transport_goto_end ();
562 void transport_goto_wallclock ();
563 void transport_stop ();
564 void transport_record (bool roll);
565 void transport_roll ();
566 void transport_play_selection();
567 void transport_play_preroll();
568 void transport_forward (int option);
569 void transport_rewind (int option);
570 void transport_loop ();
571 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
573 bool _session_is_new;
574 void set_session (ARDOUR::Session *);
575 void connect_dependents_to_session (ARDOUR::Session *);
576 void we_have_dependents ();
578 void setup_session_options ();
580 guint32 last_key_press_time;
582 void snapshot_session (bool switch_to_it);
583 void rename_session ();
588 PublicEditor *editor;
589 int create_editor ();
591 Meterbridge *meterbridge;
592 int create_meterbridge ();
593 /* Dialogs that can be created via new<T> */
595 WM::Proxy<SpeakerDialog> speaker_config_window;
596 WM::Proxy<ThemeManager> theme_manager;
597 WM::Proxy<KeyEditor> key_editor;
598 WM::Proxy<RCOptionEditor> rc_option_editor;
599 WM::Proxy<AddRouteDialog> add_route_dialog;
600 WM::Proxy<About> about;
601 WM::Proxy<LocationUIWindow> location_ui;
602 WM::Proxy<RouteParams_UI> route_params;
604 /* Windows/Dialogs that require a creator method */
606 WM::ProxyWithConstructor<SessionOptionEditor> session_option_editor;
607 WM::ProxyWithConstructor<AddVideoDialog> add_video_dialog;
608 WM::ProxyWithConstructor<BundleManager> bundle_manager;
609 WM::ProxyWithConstructor<BigClockWindow> big_clock_window;
610 WM::ProxyWithConstructor<GlobalPortMatrixWindow> audio_port_matrix;
611 WM::ProxyWithConstructor<GlobalPortMatrixWindow> midi_port_matrix;
613 /* creator methods */
615 SessionOptionEditor* create_session_option_editor ();
616 BundleManager* create_bundle_manager ();
617 AddVideoDialog* create_add_video_dialog ();
618 BigClockWindow* create_big_clock_window();
619 GlobalPortMatrixWindow* create_global_port_matrix (ARDOUR::DataType);
621 static UIConfiguration *ui_config;
623 SystemExec *video_server_process;
625 void handle_locations_change (ARDOUR::Location*);
627 /* Keyboard Handling */
629 ArdourKeyboard* keyboard;
631 /* Keymap handling */
633 void install_actions ();
635 void toggle_record_enable (uint32_t);
637 uint32_t rec_enabled_streams;
638 void count_recenabled_streams (ARDOUR::Route&);
642 void pop_back_splash (Gtk::Window&);
646 Gtk::MenuItem *cleanup_item;
648 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete);
652 bool have_configure_timeout;
653 ARDOUR::microseconds_t last_configure_time;
654 gint configure_timeout ();
656 ARDOUR::microseconds_t last_peak_grab;
657 ARDOUR::microseconds_t last_shuttle_request;
659 bool have_disk_speed_dialog_displayed;
660 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
661 void disk_overrun_handler ();
662 void disk_underrun_handler ();
664 void session_format_mismatch (std::string, std::string);
666 void session_dialog (std::string);
667 int pending_state_dialog ();
668 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
670 void disconnect_from_engine ();
671 void reconnect_to_engine ();
672 void set_engine_buffer_size (ARDOUR::pframes_t);
674 Gtk::MenuItem* jack_disconnect_item;
675 Gtk::MenuItem* jack_reconnect_item;
676 Gtk::Menu* jack_bufsize_menu;
678 Glib::RefPtr<Gtk::ActionGroup> common_actions;
680 void editor_realized ();
682 std::vector<std::string> positional_sync_strings;
684 void toggle_send_midi_feedback ();
685 void toggle_use_mmc ();
686 void toggle_send_mmc ();
687 void toggle_send_mtc ();
688 void toggle_send_midi_clock ();
690 void toggle_use_osc ();
692 void parameter_changed (std::string);
693 void session_parameter_changed (std::string);
697 void no_memory_warning ();
698 void check_memory_locking ();
700 bool check_audioengine();
701 void audioengine_setup ();
703 void display_message (const char *prefix, gint prefix_len,
704 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
706 Gtk::Label status_bar_label;
707 bool status_bar_button_press (GdkEventButton*);
708 Gtk::ToggleButton error_log_button;
710 void loading_message (const std::string& msg);
712 PBD::ScopedConnectionList forever_connections;
713 PBD::ScopedConnection halt_connection;
715 void step_edit_status_change (bool);
717 void platform_specific ();
718 void platform_setup ();
720 /* these are used only in response to a platform-specific "ShouldQuit" signal
723 void queue_finish ();
724 void fontconfig_dialog ();
726 int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
727 int ambiguous_file (std::string file, std::vector<std::string> hits);
729 bool click_button_clicked (GdkEventButton *);
731 VisibilityGroup _status_bar_visibility;
733 /** A ProcessThread so that we have some thread-local buffers for use by
734 * PluginEqGui::impulse_analysis ().
736 ARDOUR::ProcessThread* _process_thread;
738 void feedback_detected ();
740 ArdourButton midi_panic_button;
743 void successful_graph_sort ();
744 bool _feedback_exists;
746 void resize_text_widgets ();
748 std::string _announce_string;
749 void check_announcements ();
751 EngineControl* _audio_midi_setup;
752 void launch_audio_midi_setup ();
753 int do_audio_midi_setup (uint32_t);
756 #endif /* __ardour_gui_h__ */