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>
61 #include "ardour/ardour.h"
62 #include "ardour/types.h"
63 #include "ardour/utils.h"
64 #include "ardour/session_handle.h"
66 #include "ardour_dialog.h"
67 #include "ardour_button.h"
69 #include "ui_config.h"
70 #include "window_proxy.h"
72 #include "visibility_group.h"
80 class ConnectionEditor;
82 class LocationUIWindow;
87 class SessionOptionEditor;
94 class WindowProxyBase;
95 class GlobalPortMatrixWindow;
103 class ControlProtocolInfo;
112 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
115 ARDOUR_UI (int *argcp, char **argvp[]);
118 bool run_startup (bool should_be_new, std::string load_template);
124 void launch_manual ();
125 void launch_reference ();
129 void idle_load (const std::string& path);
132 int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
134 int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
135 bool session_is_new() const { return _session_is_new; }
137 ARDOUR::Session* the_session() { return _session; }
139 bool will_create_new_session_automatically() const {
140 return _will_create_new_session_automatically;
143 void set_will_create_new_session_automatically (bool yn) {
144 _will_create_new_session_automatically = yn;
147 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
148 int build_session_from_nsd (const std::string& session_name, const std::string& session_path);
149 bool ask_about_loading_existing_session (const std::string& session_path);
151 /// @return true if session was successfully unloaded.
152 int unload_session (bool hide_stuff = false);
153 void close_session();
155 int save_state_canfail (std::string state_name = "", bool switch_to_it = false);
156 void save_state (const std::string & state_name = "", bool switch_to_it = false);
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 void toggle_key_editor ();
165 void toggle_location_window ();
166 void toggle_theme_manager ();
167 void toggle_bundle_manager ();
168 void toggle_big_clock_window ();
169 void toggle_speaker_config_window ();
170 void new_midi_tracer_window ();
171 void toggle_route_params_window ();
172 void toggle_editing_space();
173 void toggle_keep_tearoffs();
175 Gtk::Tooltips& tooltips() { return _tooltips; }
177 Gtk::HBox& editor_transport_box() { return _editor_transport_box; }
179 static PublicEditor* _instance;
180 static sigc::signal<void,bool> Blink;
181 static sigc::signal<void> RapidScreenUpdate;
182 static sigc::signal<void> SuperRapidScreenUpdate;
183 /** Emitted frequently with the audible frame, false, and the edit point as
184 * parameters respectively.
186 static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
188 XMLNode* editor_settings() const;
189 XMLNode* mixer_settings () const;
190 XMLNode* keyboard_settings () const;
191 XMLNode* tearoff_settings (const char*) const;
193 void save_ardour_state ();
194 gboolean configure_handler (GdkEventConfigure* conf);
196 void do_transport_locate (framepos_t, bool);
197 void halt_on_xrun_message ();
198 void xrun_handler (framepos_t);
199 void create_xrun_marker (framepos_t);
201 GUIObjectState* gui_object_state;
203 AudioClock* primary_clock;
204 AudioClock* secondary_clock;
206 TimeInfoBox* time_info_box;
208 void store_clock_modes ();
209 void restore_clock_modes ();
210 void reset_main_clocks ();
212 void synchronize_sync_source_and_video_pullup ();
214 void add_route (Gtk::Window* float_window);
216 void session_add_audio_track (
218 int32_t output_channels,
219 ARDOUR::TrackMode mode,
220 ARDOUR::RouteGroup* route_group,
222 std::string const & name_template
225 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
228 void session_add_audio_bus (
230 int32_t output_channels,
231 ARDOUR::RouteGroup* route_group,
233 std::string const & name_template
236 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
239 void session_add_midi_track (
240 ARDOUR::RouteGroup* route_group,
242 std::string const & name_template
245 session_add_midi_route (true, route_group, how_many, name_template);
248 /*void session_add_midi_bus () {
249 session_add_midi_route (false);
252 int create_engine ();
255 gint exit_on_main_window_close (GdkEventAny *);
257 void maximise_editing_space ();
258 void restore_editing_space ();
260 void setup_profile ();
262 void setup_tooltips ();
264 void set_shuttle_fract (double);
266 void add_window_proxy (WindowProxyBase *);
267 void remove_window_proxy (WindowProxyBase *);
269 void get_process_buffers ();
270 void drop_process_buffers ();
273 friend class PublicEditor;
275 void toggle_clocking ();
276 void toggle_auto_play ();
277 void toggle_auto_input ();
278 void toggle_punch ();
279 void unset_dual_punch ();
280 bool ignore_dual_punch;
281 void toggle_punch_in ();
282 void toggle_punch_out ();
283 void show_loop_punch_ruler_and_disallow_hide ();
284 void reenable_hide_loop_punch_ruler_if_appropriate ();
285 void toggle_auto_return ();
286 void toggle_click ();
288 void toggle_session_auto_loop ();
290 void toggle_rc_options_window ();
291 void toggle_session_options_window ();
294 ArdourStartup* _startup;
295 ARDOUR::AudioEngine *engine;
296 Gtk::Tooltips _tooltips;
298 void goto_editor_window ();
299 void goto_mixer_window ();
300 void toggle_mixer_window ();
301 void toggle_mixer_on_top ();
303 int setup_windows ();
304 void setup_transport ();
307 static ARDOUR_UI *theArdourUI;
309 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
313 int ask_about_saving_session (const std::vector<std::string>& actions);
315 /* periodic safety backup, to be precise */
316 gint autosave_session();
317 void update_autosave();
318 sigc::connection _autosave_connection;
320 void map_transport_state ();
321 int32_t do_engine_start ();
323 void engine_halted (const char* reason, bool free_reason);
324 void engine_stopped ();
325 void engine_running ();
329 static gint _blink (void *);
331 gint blink_timeout_tag;
333 void start_blinking ();
334 void stop_blinking ();
336 void about_signal_response(int response);
338 Gtk::VBox top_packer;
340 sigc::connection clock_signal_connection;
341 void update_clocks ();
342 void start_clocking ();
343 void stop_clocking ();
345 void manage_window (Gtk::Window&);
347 AudioClock* big_clock;
348 ActionWindowProxy<Gtk::Window>* big_clock_window;
349 int original_big_clock_width;
350 int original_big_clock_height;
351 double original_big_clock_font_size;
353 void big_clock_size_allocate (Gtk::Allocation&);
354 bool idle_big_clock_text_resizer (int width, int height);
355 void big_clock_realized ();
356 bool big_clock_resize_in_progress;
357 int big_clock_height;
358 void big_clock_catch_focus ();
360 void float_big_clock (Gtk::Window* parent);
361 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
363 ActionWindowProxy<SpeakerDialog>* speaker_config_window;
365 void update_transport_clocks (framepos_t pos);
366 void record_state_changed ();
368 std::list<MidiTracer*> _midi_tracer_windows;
370 /* Transport Control */
372 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
373 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
375 Gtkmm2ext::TearOff* transport_tearoff;
376 Gtk::Frame transport_frame;
377 Gtk::HBox transport_tearoff_hbox;
378 Gtk::HBox _editor_transport_box;
379 Gtk::HBox transport_hbox;
380 Gtk::Fixed transport_base;
381 Gtk::Fixed transport_button_base;
382 Gtk::Frame transport_button_frame;
383 Gtk::HBox transport_button_hbox;
384 Gtk::VBox transport_button_vbox;
385 Gtk::HBox transport_option_button_hbox;
386 Gtk::VBox transport_option_button_vbox;
387 Gtk::HBox transport_clock_hbox;
388 Gtk::VBox transport_clock_vbox;
389 Gtk::HBox primary_clock_hbox;
390 Gtk::HBox secondary_clock_hbox;
392 struct TransportControllable : public PBD::Controllable {
403 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
404 void set_value (double);
405 double get_value (void) const;
411 boost::shared_ptr<TransportControllable> roll_controllable;
412 boost::shared_ptr<TransportControllable> stop_controllable;
413 boost::shared_ptr<TransportControllable> goto_start_controllable;
414 boost::shared_ptr<TransportControllable> goto_end_controllable;
415 boost::shared_ptr<TransportControllable> auto_loop_controllable;
416 boost::shared_ptr<TransportControllable> play_selection_controllable;
417 boost::shared_ptr<TransportControllable> rec_controllable;
418 boost::shared_ptr<TransportControllable> shuttle_controllable;
419 boost::shared_ptr<TransportControllable> join_play_range_controllable;
421 void set_transport_controllable_state (const XMLNode&);
422 XMLNode& get_transport_controllable_state ();
424 ArdourButton roll_button;
425 ArdourButton stop_button;
426 ArdourButton goto_start_button;
427 ArdourButton goto_end_button;
428 ArdourButton auto_loop_button;
429 ArdourButton play_selection_button;
430 ArdourButton rec_button;
431 ArdourButton join_play_range_button;
433 void toggle_external_sync ();
434 void toggle_time_master ();
435 void toggle_video_sync ();
437 ShuttleControl* shuttle_box;
439 ArdourButton auto_return_button;
440 ArdourButton auto_play_button;
441 ArdourButton auto_input_button;
442 ArdourButton click_button;
443 ArdourButton sync_button;
445 ArdourButton auditioning_alert_button;
446 ArdourButton solo_alert_button;
447 ArdourButton feedback_alert_button;
451 void solo_blink (bool);
452 void sync_blink (bool);
453 void audition_blink (bool);
454 void feedback_blink (bool);
456 void soloing_changed (bool);
457 void auditioning_changed (bool);
458 void _auditioning_changed (bool);
460 bool solo_alert_press (GdkEventButton* ev);
461 bool audition_alert_press (GdkEventButton* ev);
462 bool feedback_alert_press (GdkEventButton *);
464 void big_clock_value_changed ();
465 void primary_clock_value_changed ();
466 void secondary_clock_value_changed ();
468 /* called by Blink signal */
470 void transport_rec_enable_blink (bool onoff);
472 Gtk::Menu* session_popup_menu;
474 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
475 RecentSessionModelColumns() {
479 Gtk::TreeModelColumn<std::string> visible_name;
480 Gtk::TreeModelColumn<std::string> fullpath;
483 RecentSessionModelColumns recent_session_columns;
484 Gtk::TreeView recent_session_display;
485 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
487 ArdourDialog* session_selector_window;
488 Gtk::FileChooserDialog* open_session_selector;
490 void build_session_selector();
491 void redisplay_recent_sessions();
492 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
494 struct RecentSessionsSorter {
495 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
496 return cmp_nocase(a.first, b.first) == -1;
500 /* menu bar and associated stuff */
502 Gtk::MenuBar* menu_bar;
503 Gtk::EventBox menu_bar_base;
506 void use_menubar_as_top_menubar ();
507 void build_menu_bar ();
509 Gtk::Label wall_clock_label;
510 Gtk::EventBox wall_clock_box;
511 gint update_wall_clock ();
513 Gtk::Label disk_space_label;
514 Gtk::EventBox disk_space_box;
515 void update_disk_space ();
517 Gtk::Label cpu_load_label;
518 Gtk::EventBox cpu_load_box;
519 void update_cpu_load ();
521 Gtk::Label buffer_load_label;
522 Gtk::EventBox buffer_load_box;
523 void update_buffer_load ();
525 Gtk::Label sample_rate_label;
526 Gtk::EventBox sample_rate_box;
527 void update_sample_rate (ARDOUR::framecnt_t);
529 Gtk::Label format_label;
530 Gtk::EventBox format_box;
531 void update_format ();
533 gint every_second ();
534 gint every_point_one_seconds ();
535 gint every_point_zero_one_seconds ();
537 sigc::connection second_connection;
538 sigc::connection point_one_second_connection;
539 sigc::connection point_oh_five_second_connection;
540 sigc::connection point_zero_one_second_connection;
542 gint session_menu (GdkEventButton *);
544 bool _will_create_new_session_automatically;
546 void open_session ();
547 void open_recent_session ();
548 void save_template ();
550 void edit_metadata ();
551 void import_metadata ();
553 void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
554 void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &);
556 void set_transport_sensitivity (bool);
558 void remove_last_capture ();
560 void transport_goto_zero ();
561 void transport_goto_start ();
562 void transport_goto_end ();
563 void transport_goto_wallclock ();
564 void transport_stop ();
565 void transport_stop_and_forget_capture ();
566 void transport_record (bool roll);
567 void transport_roll ();
568 void transport_play_selection();
569 void transport_forward (int option);
570 void transport_rewind (int option);
571 void transport_loop ();
572 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
574 bool _session_is_new;
575 void set_session (ARDOUR::Session *);
576 void connect_dependents_to_session (ARDOUR::Session *);
577 void we_have_dependents ();
579 void setup_session_options ();
581 guint32 last_key_press_time;
583 void snapshot_session (bool switch_to_it);
584 void rename_session ();
589 PublicEditor *editor;
590 int create_editor ();
592 RouteParams_UI *route_params;
593 int create_route_params ();
595 BundleManager *bundle_manager;
596 void create_bundle_manager ();
598 ActionWindowProxy<LocationUIWindow>* location_ui;
599 int create_location_ui ();
600 void handle_locations_change (ARDOUR::Location*);
602 ActionWindowProxy<GlobalPortMatrixWindow>* _global_port_matrix[ARDOUR::DataType::num_types];
603 void toggle_global_port_matrix (ARDOUR::DataType);
605 static UIConfiguration *ui_config;
606 ThemeManager *theme_manager;
608 /* Key bindings editor */
610 KeyEditor *key_editor;
612 /* RC Options window */
614 RCOptionEditor *rc_option_editor;
616 SessionOptionEditor *session_option_editor;
620 AddRouteDialog *add_route_dialog;
622 /* Keyboard Handling */
624 ArdourKeyboard* keyboard;
626 /* Keymap handling */
628 void install_actions ();
630 void toggle_record_enable (uint32_t);
632 uint32_t rec_enabled_streams;
633 void count_recenabled_streams (ARDOUR::Route&);
637 void pop_back_splash ();
641 Gtk::MenuItem *cleanup_item;
643 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title,
644 const std::string& plural_msg, const std::string& singular_msg);
648 bool have_configure_timeout;
649 ARDOUR::microseconds_t last_configure_time;
650 gint configure_timeout ();
652 ARDOUR::microseconds_t last_peak_grab;
653 ARDOUR::microseconds_t last_shuttle_request;
655 bool have_disk_speed_dialog_displayed;
656 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
657 void disk_overrun_handler ();
658 void disk_underrun_handler ();
660 void session_dialog (std::string);
661 int pending_state_dialog ();
662 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
664 void disconnect_from_jack ();
665 void reconnect_to_jack ();
666 void set_jack_buffer_size (ARDOUR::pframes_t);
668 Gtk::MenuItem* jack_disconnect_item;
669 Gtk::MenuItem* jack_reconnect_item;
670 Gtk::Menu* jack_bufsize_menu;
672 Glib::RefPtr<Gtk::ActionGroup> common_actions;
674 void editor_realized ();
676 std::vector<std::string> positional_sync_strings;
678 void toggle_send_midi_feedback ();
679 void toggle_use_mmc ();
680 void toggle_send_mmc ();
681 void toggle_send_mtc ();
682 void toggle_send_midi_clock ();
684 void toggle_use_osc ();
686 void parameter_changed (std::string);
687 void session_parameter_changed (std::string);
691 void no_memory_warning ();
692 void check_memory_locking ();
694 bool check_audioengine();
695 void audioengine_setup ();
697 void display_message (const char *prefix, gint prefix_len,
698 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
700 Gtk::Label status_bar_label;
701 bool status_bar_button_press (GdkEventButton*);
702 Gtk::ToggleButton error_log_button;
704 void loading_message (const std::string& msg);
705 void end_loading_messages ();
707 void toggle_translations ();
709 PBD::ScopedConnectionList forever_connections;
711 void step_edit_status_change (bool);
713 void platform_specific ();
714 void platform_setup ();
716 /* these are used only in response to a platform-specific "ShouldQuit" signal
719 void queue_finish ();
720 void fontconfig_dialog ();
722 std::list<WindowProxyBase*> _window_proxies;
724 int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
725 int ambiguous_file (std::string file, std::string path, std::vector<std::string> hits);
727 bool click_button_clicked (GdkEventButton *);
729 VisibilityGroup _status_bar_visibility;
731 /** A ProcessThread so that we have some thread-local buffers for use by
732 * PluginEqGui::impulse_analysis ().
734 ARDOUR::ProcessThread* _process_thread;
736 void feedback_detected ();
738 ArdourButton midi_panic_button;
741 void successful_graph_sort ();
742 bool _feedback_exists;
744 void resize_text_widgets ();
747 #endif /* __ardour_gui_h__ */