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"
68 #include "ui_config.h"
69 #include "window_proxy.h"
71 #include "visibility_group.h"
79 class ConnectionEditor;
81 class LocationUIWindow;
86 class SessionOptionEditor;
93 class WindowProxyBase;
94 class GlobalPortMatrixWindow;
102 class ControlProtocolInfo;
111 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
114 ARDOUR_UI (int *argcp, char **argvp[]);
117 bool run_startup (bool should_be_new, std::string load_template);
123 void launch_manual ();
124 void launch_reference ();
128 void idle_load (const std::string& path);
131 int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
133 int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
134 bool session_is_new() const { return _session_is_new; }
136 ARDOUR::Session* the_session() { return _session; }
138 bool will_create_new_session_automatically() const {
139 return _will_create_new_session_automatically;
142 void set_will_create_new_session_automatically (bool yn) {
143 _will_create_new_session_automatically = yn;
146 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
147 int build_session_from_nsd (const std::string& session_name, const std::string& session_path);
148 bool ask_about_loading_existing_session (const std::string& session_path);
150 /// @return true if session was successfully unloaded.
151 int unload_session (bool hide_stuff = false);
152 void close_session();
154 int save_state_canfail (std::string state_name = "", bool switch_to_it = false);
155 void save_state (const std::string & state_name = "", bool switch_to_it = false);
157 static ARDOUR_UI *instance () { return theArdourUI; }
158 static UIConfiguration *config () { return ui_config; }
160 PublicEditor& the_editor(){return *editor;}
161 Mixer_UI* the_mixer() { return mixer; }
163 void toggle_key_editor ();
164 void toggle_location_window ();
165 void toggle_theme_manager ();
166 void toggle_bundle_manager ();
167 void toggle_big_clock_window ();
168 void toggle_speaker_config_window ();
169 void new_midi_tracer_window ();
170 void toggle_route_params_window ();
171 void toggle_editing_space();
172 void toggle_keep_tearoffs();
174 Gtk::Tooltips& tooltips() { return _tooltips; }
176 Gtk::HBox& editor_transport_box() { return _editor_transport_box; }
178 static PublicEditor* _instance;
179 static sigc::signal<void,bool> Blink;
180 static sigc::signal<void> RapidScreenUpdate;
181 static sigc::signal<void> SuperRapidScreenUpdate;
182 /** Emitted frequently with the audible frame, false, and the edit point as
183 * parameters respectively.
185 static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
187 XMLNode* editor_settings() const;
188 XMLNode* mixer_settings () const;
189 XMLNode* keyboard_settings () const;
190 XMLNode* tearoff_settings (const char*) const;
192 void save_ardour_state ();
193 gboolean configure_handler (GdkEventConfigure* conf);
195 void do_transport_locate (framepos_t, bool);
196 void halt_on_xrun_message ();
197 void xrun_handler (framepos_t);
198 void create_xrun_marker (framepos_t);
200 GUIObjectState* gui_object_state;
202 AudioClock* primary_clock;
203 AudioClock* secondary_clock;
204 AudioClock* preroll_clock;
205 AudioClock* postroll_clock;
207 TimeInfoBox* time_info_box;
209 void store_clock_modes ();
210 void restore_clock_modes ();
211 void reset_main_clocks ();
213 void synchronize_sync_source_and_video_pullup ();
215 void add_route (Gtk::Window* float_window);
217 void session_add_audio_track (
219 int32_t output_channels,
220 ARDOUR::TrackMode mode,
221 ARDOUR::RouteGroup* route_group,
223 std::string const & name_template
226 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
229 void session_add_audio_bus (
231 int32_t output_channels,
232 ARDOUR::RouteGroup* route_group,
234 std::string const & name_template
237 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
240 void session_add_midi_track (
241 ARDOUR::RouteGroup* route_group,
243 std::string const & name_template
246 session_add_midi_route (true, route_group, how_many, name_template);
249 /*void session_add_midi_bus () {
250 session_add_midi_route (false);
253 int create_engine ();
256 gint exit_on_main_window_close (GdkEventAny *);
258 void maximise_editing_space ();
259 void restore_editing_space ();
261 void setup_profile ();
263 void setup_tooltips ();
265 void set_shuttle_fract (double);
267 void add_window_proxy (WindowProxyBase *);
268 void remove_window_proxy (WindowProxyBase *);
270 void get_process_buffers ();
271 void drop_process_buffers ();
274 friend class PublicEditor;
276 void toggle_clocking ();
277 void toggle_auto_play ();
278 void toggle_auto_input ();
279 void toggle_punch ();
280 void unset_dual_punch ();
281 bool ignore_dual_punch;
282 void toggle_punch_in ();
283 void toggle_punch_out ();
284 void show_loop_punch_ruler_and_disallow_hide ();
285 void reenable_hide_loop_punch_ruler_if_appropriate ();
286 void toggle_auto_return ();
287 void toggle_click ();
289 void toggle_session_auto_loop ();
291 void toggle_rc_options_window ();
292 void toggle_session_options_window ();
295 ArdourStartup* _startup;
296 ARDOUR::AudioEngine *engine;
297 Gtk::Tooltips _tooltips;
299 void goto_editor_window ();
300 void goto_mixer_window ();
301 void toggle_mixer_window ();
302 void toggle_mixer_on_top ();
304 Gtk::ToggleButton preroll_button;
305 Gtk::ToggleButton postroll_button;
307 int setup_windows ();
308 void setup_transport ();
311 static ARDOUR_UI *theArdourUI;
313 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
317 int ask_about_saving_session (const std::vector<std::string>& actions);
319 /* periodic safety backup, to be precise */
320 gint autosave_session();
321 void update_autosave();
322 sigc::connection _autosave_connection;
324 void map_transport_state ();
325 int32_t do_engine_start ();
327 void engine_halted (const char* reason, bool free_reason);
328 void engine_stopped ();
329 void engine_running ();
333 static gint _blink (void *);
335 gint blink_timeout_tag;
337 void start_blinking ();
338 void stop_blinking ();
340 void about_signal_response(int response);
342 Gtk::VBox top_packer;
344 sigc::connection clock_signal_connection;
345 void update_clocks ();
346 void start_clocking ();
347 void stop_clocking ();
349 void manage_window (Gtk::Window&);
351 AudioClock* big_clock;
352 ActionWindowProxy<Gtk::Window>* big_clock_window;
353 int original_big_clock_width;
354 int original_big_clock_height;
355 double original_big_clock_font_size;
357 void big_clock_size_allocate (Gtk::Allocation&);
358 bool idle_big_clock_text_resizer (int width, int height);
359 void big_clock_realized ();
360 bool big_clock_resize_in_progress;
361 int big_clock_height;
363 void float_big_clock (Gtk::Window* parent);
364 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
366 ActionWindowProxy<SpeakerDialog>* speaker_config_window;
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;
421 boost::shared_ptr<TransportControllable> shuttle_controllable;
422 boost::shared_ptr<TransportControllable> join_play_range_controllable;
424 void set_transport_controllable_state (const XMLNode&);
425 XMLNode& get_transport_controllable_state ();
427 BindableButton roll_button;
428 BindableButton stop_button;
429 BindableButton goto_start_button;
430 BindableButton goto_end_button;
431 BindableButton auto_loop_button;
432 BindableButton play_selection_button;
433 BindableButton rec_button;
434 BindableToggleButton join_play_range_button;
436 void toggle_external_sync ();
437 void toggle_time_master ();
438 void toggle_video_sync ();
440 ShuttleControl* shuttle_box;
442 Gtkmm2ext::StatefulToggleButton auto_return_button;
443 Gtkmm2ext::StatefulToggleButton auto_play_button;
444 Gtkmm2ext::StatefulToggleButton auto_input_button;
445 Gtkmm2ext::StatefulToggleButton click_button;
446 Gtkmm2ext::StatefulToggleButton time_master_button;
447 Gtkmm2ext::StatefulToggleButton sync_button;
449 Gtk::ToggleButton auditioning_alert_button;
450 Gtk::ToggleButton solo_alert_button;
454 void solo_blink (bool);
455 void sync_blink (bool);
456 void audition_blink (bool);
458 void soloing_changed (bool);
459 void auditioning_changed (bool);
460 void _auditioning_changed (bool);
462 bool solo_alert_press (GdkEventButton* ev);
463 bool audition_alert_press (GdkEventButton* ev);
465 void big_clock_value_changed ();
466 void primary_clock_value_changed ();
467 void secondary_clock_value_changed ();
469 /* called by Blink signal */
471 void transport_rec_enable_blink (bool onoff);
473 Gtk::Menu* session_popup_menu;
475 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
476 RecentSessionModelColumns() {
480 Gtk::TreeModelColumn<std::string> visible_name;
481 Gtk::TreeModelColumn<std::string> fullpath;
484 RecentSessionModelColumns recent_session_columns;
485 Gtk::TreeView recent_session_display;
486 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
488 ArdourDialog* session_selector_window;
489 Gtk::FileChooserDialog* open_session_selector;
491 void build_session_selector();
492 void redisplay_recent_sessions();
493 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
495 struct RecentSessionsSorter {
496 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
497 return cmp_nocase(a.first, b.first) == -1;
501 /* menu bar and associated stuff */
503 Gtk::MenuBar* menu_bar;
504 Gtk::EventBox menu_bar_base;
507 void use_menubar_as_top_menubar ();
508 void build_menu_bar ();
510 Gtk::Label wall_clock_label;
511 Gtk::EventBox wall_clock_box;
512 gint update_wall_clock ();
514 Gtk::Label disk_space_label;
515 Gtk::EventBox disk_space_box;
516 void update_disk_space ();
518 Gtk::Label cpu_load_label;
519 Gtk::EventBox cpu_load_box;
520 void update_cpu_load ();
522 Gtk::Label buffer_load_label;
523 Gtk::EventBox buffer_load_box;
524 void update_buffer_load ();
526 Gtk::Label sample_rate_label;
527 Gtk::EventBox sample_rate_box;
528 void update_sample_rate (ARDOUR::framecnt_t);
530 Gtk::Label format_label;
531 Gtk::EventBox format_box;
532 void update_format ();
534 gint every_second ();
535 gint every_point_one_seconds ();
536 gint every_point_zero_one_seconds ();
538 sigc::connection second_connection;
539 sigc::connection point_one_second_connection;
540 sigc::connection point_oh_five_second_connection;
541 sigc::connection point_zero_one_second_connection;
543 gint session_menu (GdkEventButton *);
545 bool _will_create_new_session_automatically;
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 &);
557 void set_transport_sensitivity (bool);
559 void remove_last_capture ();
561 void transport_goto_zero ();
562 void transport_goto_start ();
563 void transport_goto_end ();
564 void transport_goto_wallclock ();
565 void transport_stop ();
566 void transport_stop_and_forget_capture ();
567 void transport_record (bool roll);
568 void transport_roll ();
569 void transport_play_selection();
570 void transport_forward (int option);
571 void transport_rewind (int option);
572 void transport_loop ();
573 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
575 bool _session_is_new;
576 void set_session (ARDOUR::Session *);
577 void connect_dependents_to_session (ARDOUR::Session *);
578 void we_have_dependents ();
580 void setup_session_options ();
582 guint32 last_key_press_time;
584 void snapshot_session (bool switch_to_it);
585 void rename_session ();
590 PublicEditor *editor;
591 int create_editor ();
593 RouteParams_UI *route_params;
594 int create_route_params ();
596 BundleManager *bundle_manager;
597 void create_bundle_manager ();
599 ActionWindowProxy<LocationUIWindow>* location_ui;
600 int create_location_ui ();
601 void handle_locations_change (ARDOUR::Location*);
603 ActionWindowProxy<GlobalPortMatrixWindow>* _global_port_matrix[ARDOUR::DataType::num_types];
604 void toggle_global_port_matrix (ARDOUR::DataType);
606 static UIConfiguration *ui_config;
607 ThemeManager *theme_manager;
609 /* Key bindings editor */
611 KeyEditor *key_editor;
613 /* RC Options window */
615 RCOptionEditor *rc_option_editor;
617 SessionOptionEditor *session_option_editor;
621 AddRouteDialog *add_route_dialog;
623 /* Keyboard Handling */
625 ArdourKeyboard* keyboard;
627 /* Keymap handling */
629 void install_actions ();
631 void toggle_record_enable (uint32_t);
633 uint32_t rec_enabled_streams;
634 void count_recenabled_streams (ARDOUR::Route&);
638 void pop_back_splash ();
642 Gtk::MenuItem *cleanup_item;
644 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title,
645 const std::string& plural_msg, const std::string& singular_msg);
649 bool have_configure_timeout;
650 ARDOUR::microseconds_t last_configure_time;
651 gint configure_timeout ();
653 ARDOUR::microseconds_t last_peak_grab;
654 ARDOUR::microseconds_t last_shuttle_request;
656 bool have_disk_speed_dialog_displayed;
657 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
658 void disk_overrun_handler ();
659 void disk_underrun_handler ();
661 void session_dialog (std::string);
662 int pending_state_dialog ();
663 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
665 void disconnect_from_jack ();
666 void reconnect_to_jack ();
667 void set_jack_buffer_size (ARDOUR::pframes_t);
669 Gtk::MenuItem* jack_disconnect_item;
670 Gtk::MenuItem* jack_reconnect_item;
671 Gtk::Menu* jack_bufsize_menu;
673 Glib::RefPtr<Gtk::ActionGroup> common_actions;
675 void editor_realized ();
677 std::vector<std::string> positional_sync_strings;
679 void toggle_send_midi_feedback ();
680 void toggle_use_mmc ();
681 void toggle_send_mmc ();
682 void toggle_send_mtc ();
683 void toggle_send_midi_clock ();
685 void toggle_use_osc ();
687 void parameter_changed (std::string);
688 void session_parameter_changed (std::string);
692 void no_memory_warning ();
693 void check_memory_locking ();
695 bool check_audioengine();
696 void audioengine_setup ();
698 void display_message (const char *prefix, gint prefix_len,
699 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
701 Gtk::Label status_bar_label;
702 bool status_bar_button_press (GdkEventButton*);
703 Gtk::ToggleButton error_log_button;
705 void loading_message (const std::string& msg);
706 void end_loading_messages ();
708 void toggle_translations ();
710 PBD::ScopedConnectionList forever_connections;
712 void step_edit_status_change (bool);
714 void platform_specific ();
715 void platform_setup ();
717 /* these are used only in response to a platform-specific "ShouldQuit" signal
720 void queue_finish ();
721 void fontconfig_dialog ();
723 std::list<WindowProxyBase*> _window_proxies;
725 int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
726 int ambiguous_file (std::string file, std::string path, std::vector<std::string> hits);
728 bool click_button_clicked (GdkEventButton *);
730 VisibilityGroup _status_bar_visibility;
732 /** A ProcessThread so that we have some thread-local buffers for use by
733 * PluginEqGui::impulse_analysis ().
735 ARDOUR::ProcessThread* _process_thread;
738 #endif /* __ardour_gui_h__ */