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/session.h"
63 #include "ardour/types.h"
65 #include "audio_clock.h"
66 #include "ardour_dialog.h"
68 #include "ui_config.h"
74 class SessionOptionEditor;
77 class ConnectionEditor;
96 class ControlProtocolInfo;
100 class MultiChannelDevice;
103 #define FRAME_NAME "BaseFrame"
105 extern sigc::signal<void> ColorsChanged;
106 extern sigc::signal<void> DPIReset;
108 class ARDOUR_UI : public Gtkmm2ext::UI
111 ARDOUR_UI (int *argcp, char **argvp[]);
114 void run_startup (bool should_be_new);
117 bool shown() { return shown_flag; }
127 int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
129 int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
131 uint32_t master_chns,
132 ARDOUR::AutoConnectOption input_connect,
133 ARDOUR::AutoConnectOption output_connect,
136 nframes_t initial_length);
137 bool session_is_new() const { return _session_is_new; }
139 ARDOUR::Session* the_session() { return session; }
141 bool will_create_new_session_automatically() const {
142 return _will_create_new_session_automatically;
145 void set_will_create_new_session_automatically (bool yn) {
146 _will_create_new_session_automatically = yn;
149 int get_session_parameters (bool should_be_new = false);
150 void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
151 int load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
152 int build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
153 bool ask_about_loading_existing_session (const Glib::ustring& session_path);
155 /// @return true if session was successfully unloaded.
156 int unload_session (bool hide_stuff = false);
157 void close_session();
159 int save_state_canfail (std::string state_name = "");
160 void save_state (const std::string & state_name = "");
162 static double gain_to_slider_position (ARDOUR::gain_t g);
163 static ARDOUR::gain_t slider_position_to_gain (double pos);
165 static ARDOUR_UI *instance () { return theArdourUI; }
166 static UIConfiguration *config () { return ui_config; }
168 PublicEditor& the_editor(){return *editor;}
169 Mixer_UI* the_mixer() { return mixer; }
171 ARDOUR::AudioEngine& the_engine() const { return *engine; }
173 void toggle_key_editor ();
174 void toggle_location_window ();
175 void toggle_theme_manager ();
176 void toggle_bundle_manager ();
177 void toggle_big_clock_window ();
178 void toggle_route_params_window ();
179 void toggle_editing_space();
181 Gtk::Tooltips& tooltips() { return _tooltips; }
183 static sigc::signal<void,bool> Blink;
184 static sigc::signal<void> RapidScreenUpdate;
185 static sigc::signal<void> SuperRapidScreenUpdate;
186 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
188 void name_io_setup (ARDOUR::AudioEngine&, std::string&, ARDOUR::IO& io, bool in);
190 XMLNode* editor_settings() const;
191 XMLNode* mixer_settings () const;
192 XMLNode* keyboard_settings () const;
194 void save_ardour_state ();
195 gboolean configure_handler (GdkEventConfigure* conf);
197 void do_transport_locate (nframes_t position);
198 void halt_on_xrun_message ();
199 void xrun_handler (nframes_t);
200 void create_xrun_marker (nframes_t);
202 AudioClock primary_clock;
203 AudioClock secondary_clock;
204 AudioClock preroll_clock;
205 AudioClock postroll_clock;
207 void store_clock_modes ();
208 void restore_clock_modes ();
210 void add_route (Gtk::Window* float_window);
212 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
213 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
216 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
217 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
220 void session_add_midi_track (uint32_t how_many) {
221 session_add_midi_route (true, how_many);
224 /*void session_add_midi_bus () {
225 session_add_midi_route (false);
228 int create_engine ();
231 gint exit_on_main_window_close (GdkEventAny *);
233 void maximise_editing_space ();
234 void restore_editing_space ();
236 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
237 void set_native_file_data_format (ARDOUR::SampleFormat sf);
239 void setup_profile ();
242 void set_shuttle_fract (double);
245 friend class PublicEditor;
247 void toggle_clocking ();
248 void toggle_auto_play ();
249 void toggle_auto_input ();
250 void toggle_punch ();
251 void unset_dual_punch ();
252 bool ignore_dual_punch;
253 void toggle_punch_in ();
254 void toggle_punch_out ();
255 void toggle_auto_return ();
256 void toggle_click ();
258 void toggle_session_auto_loop ();
260 void toggle_rc_options_window ();
261 void toggle_session_options_window ();
264 ArdourStartup* _startup;
265 ARDOUR::AudioEngine *engine;
266 ARDOUR::Session *session;
267 Gtk::Tooltips _tooltips;
269 void goto_editor_window ();
270 void goto_mixer_window ();
271 void toggle_editor_mixer_on_top ();
274 Gtk::ToggleButton preroll_button;
275 Gtk::ToggleButton postroll_button;
277 int setup_windows ();
278 void setup_transport ();
281 static ARDOUR_UI *theArdourUI;
283 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
287 int ask_about_saving_session (const std::string & why);
289 /* periodic safety backup, to be precise */
290 gint autosave_session();
291 void update_autosave();
292 sigc::connection _autosave_connection;
294 void queue_transport_change ();
295 void map_transport_state ();
296 int32_t do_engine_start ();
298 void engine_halted ();
299 void engine_stopped ();
300 void engine_running ();
304 static gint _blink (void *);
306 gint blink_timeout_tag;
308 void start_blinking ();
309 void stop_blinking ();
311 void about_signal_response(int response);
314 Gtk::VBox top_packer;
316 sigc::connection clock_signal_connection;
317 void update_clocks ();
318 void start_clocking ();
319 void stop_clocking ();
321 void manage_window (Gtk::Window&);
323 AudioClock big_clock;
324 Gtk::Window* big_clock_window;
326 void float_big_clock (Gtk::Window* parent);
327 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
329 void update_transport_clocks (nframes_t pos);
330 void record_state_changed ();
332 /* Transport Control */
334 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
335 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
337 Gtkmm2ext::TearOff* transport_tearoff;
338 Gtk::Frame transport_frame;
339 Gtk::HBox transport_tearoff_hbox;
340 Gtk::HBox transport_hbox;
341 Gtk::Fixed transport_base;
342 Gtk::Fixed transport_button_base;
343 Gtk::Frame transport_button_frame;
344 Gtk::HBox transport_button_hbox;
345 Gtk::VBox transport_button_vbox;
346 Gtk::HBox transport_option_button_hbox;
347 Gtk::VBox transport_option_button_vbox;
348 Gtk::HBox transport_clock_hbox;
349 Gtk::VBox transport_clock_vbox;
350 Gtk::HBox primary_clock_hbox;
351 Gtk::HBox secondary_clock_hbox;
354 struct TransportControllable : public PBD::Controllable {
367 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
368 void set_value (float);
369 float get_value (void) const;
371 void set_id (const std::string&);
377 boost::shared_ptr<TransportControllable> roll_controllable;
378 boost::shared_ptr<TransportControllable> stop_controllable;
379 boost::shared_ptr<TransportControllable> goto_start_controllable;
380 boost::shared_ptr<TransportControllable> goto_end_controllable;
381 boost::shared_ptr<TransportControllable> auto_loop_controllable;
382 boost::shared_ptr<TransportControllable> play_selection_controllable;
383 boost::shared_ptr<TransportControllable> rec_controllable;
384 boost::shared_ptr<TransportControllable> shuttle_controllable;
385 BindingProxy shuttle_controller_binding_proxy;
387 void set_transport_controllable_state (const XMLNode&);
388 XMLNode& get_transport_controllable_state ();
390 BindableButton roll_button;
391 BindableButton stop_button;
392 BindableButton goto_start_button;
393 BindableButton goto_end_button;
394 BindableButton auto_loop_button;
395 BindableButton play_selection_button;
396 BindableButton rec_button;
398 Gtk::ComboBoxText sync_option_combo;
400 void sync_option_changed ();
401 void toggle_time_master ();
402 void toggle_video_sync ();
404 Gtk::DrawingArea shuttle_box;
405 Gtk::EventBox speed_display_box;
406 Gtk::Label speed_display_label;
407 Gtk::Button shuttle_units_button;
408 Gtk::ComboBoxText shuttle_style_button;
409 Gtk::Menu* shuttle_unit_menu;
410 Gtk::Menu* shuttle_style_menu;
411 float shuttle_max_speed;
412 Gtk::Menu* shuttle_context_menu;
414 void build_shuttle_context_menu ();
415 void show_shuttle_context_menu ();
416 void shuttle_style_changed();
417 void shuttle_unit_clicked ();
418 void set_shuttle_max_speed (float);
419 void update_speed_display ();
420 float last_speed_displayed;
422 gint shuttle_box_button_press (GdkEventButton*);
423 gint shuttle_box_button_release (GdkEventButton*);
424 gint shuttle_box_scroll (GdkEventScroll*);
425 gint shuttle_box_motion (GdkEventMotion*);
426 gint shuttle_box_expose (GdkEventExpose*);
427 gint mouse_shuttle (double x, bool force);
428 void use_shuttle_fract (bool force);
430 bool shuttle_grabbed;
431 double shuttle_fract;
433 Gtkmm2ext::StatefulToggleButton punch_in_button;
434 Gtkmm2ext::StatefulToggleButton punch_out_button;
435 Gtkmm2ext::StatefulToggleButton auto_return_button;
436 Gtkmm2ext::StatefulToggleButton auto_play_button;
437 Gtkmm2ext::StatefulToggleButton auto_input_button;
438 Gtkmm2ext::StatefulToggleButton click_button;
439 Gtkmm2ext::StatefulToggleButton time_master_button;
441 Gtk::ToggleButton auditioning_alert_button;
442 Gtk::ToggleButton solo_alert_button;
446 void solo_blink (bool);
447 void audition_blink (bool);
449 void soloing_changed (bool);
450 void auditioning_changed (bool);
451 void _auditioning_changed (bool);
453 void solo_alert_toggle ();
454 void audition_alert_toggle ();
456 void big_clock_value_changed ();
457 void primary_clock_value_changed ();
458 void secondary_clock_value_changed ();
460 /* called by Blink signal */
462 void transport_rec_enable_blink (bool onoff);
464 Gtk::Menu* session_popup_menu;
466 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
467 RecentSessionModelColumns() {
471 Gtk::TreeModelColumn<Glib::ustring> visible_name;
472 Gtk::TreeModelColumn<Glib::ustring> fullpath;
475 RecentSessionModelColumns recent_session_columns;
476 Gtk::TreeView recent_session_display;
477 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
479 ArdourDialog* session_selector_window;
480 Gtk::FileChooserDialog* open_session_selector;
482 void build_session_selector();
483 void redisplay_recent_sessions();
484 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
486 struct RecentSessionsSorter {
487 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
488 return cmp_nocase(a.first, b.first) == -1;
492 /* menu bar and associated stuff */
494 Gtk::MenuBar* menu_bar;
495 Gtk::EventBox menu_bar_base;
498 void use_menubar_as_top_menubar ();
499 void build_menu_bar ();
500 void build_control_surface_menu ();
502 Gtk::Label wall_clock_label;
503 Gtk::EventBox wall_clock_box;
504 gint update_wall_clock ();
506 Gtk::Label disk_space_label;
507 Gtk::EventBox disk_space_box;
508 void update_disk_space ();
510 Gtk::Label cpu_load_label;
511 Gtk::EventBox cpu_load_box;
512 void update_cpu_load ();
514 Gtk::Label buffer_load_label;
515 Gtk::EventBox buffer_load_box;
516 void update_buffer_load ();
518 Gtk::Label sample_rate_label;
519 Gtk::EventBox sample_rate_box;
520 void update_sample_rate (nframes_t);
522 gint every_second ();
523 gint every_point_one_seconds ();
524 gint every_point_zero_one_seconds ();
526 sigc::connection second_connection;
527 sigc::connection point_one_second_connection;
528 sigc::connection point_oh_five_second_connection;
529 sigc::connection point_zero_one_second_connection;
531 gint session_menu (GdkEventButton *);
533 bool _will_create_new_session_automatically;
535 void open_session ();
536 void open_recent_session ();
537 void save_template ();
539 void edit_metadata ();
540 void import_metadata ();
542 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
543 void session_add_midi_route (bool disk, uint32_t how_many);
545 void set_transport_sensitivity (bool);
547 void remove_last_capture ();
549 void transport_goto_zero ();
550 void transport_goto_start ();
551 void transport_goto_end ();
552 void transport_goto_wallclock ();
553 void transport_stop ();
554 void transport_stop_and_forget_capture ();
555 void transport_record (bool roll);
556 void transport_roll ();
557 void transport_play_selection();
558 void transport_forward (int option);
559 void transport_rewind (int option);
560 void transport_loop ();
562 void transport_rolling ();
563 void transport_rewinding ();
564 void transport_forwarding ();
565 void transport_stopped ();
567 bool _session_is_new;
568 void connect_to_session (ARDOUR::Session *);
569 void connect_dependents_to_session (ARDOUR::Session *);
570 void we_have_dependents ();
572 void setup_session_options ();
574 guint32 last_key_press_time;
576 void snapshot_session ();
581 PublicEditor *editor;
582 int create_editor ();
584 RouteParams_UI *route_params;
585 int create_route_params ();
587 BundleManager *bundle_manager;
588 void create_bundle_manager ();
590 LocationUI *location_ui;
591 int create_location_ui ();
592 void handle_locations_change (ARDOUR::Location*);
594 static UIConfiguration *ui_config;
595 ThemeManager *theme_manager;
597 /* Key bindings editor */
599 KeyEditor *key_editor;
601 /* RC Options window */
603 RCOptionEditor *rc_option_editor;
605 SessionOptionEditor *session_option_editor;
609 AddRouteDialog *add_route_dialog;
611 /* Keyboard Handling */
615 /* Keymap handling */
617 void install_actions ();
619 void toggle_record_enable (uint32_t);
621 uint32_t rec_enabled_streams;
622 void count_recenabled_streams (ARDOUR::Route&);
626 void pop_back_splash ();
631 Gtk::MenuItem *cleanup_item;
633 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const std::string & msg);
637 bool have_configure_timeout;
638 ARDOUR::microseconds_t last_configure_time;
639 gint configure_timeout ();
641 ARDOUR::microseconds_t last_peak_grab;
642 ARDOUR::microseconds_t last_shuttle_request;
644 struct DiskBufferStat {
649 DiskBufferStat (time_t w, uint32_t c, uint32_t p)
650 : when (w), capture (c), playback (p) {}
653 std::list<DiskBufferStat> disk_buffer_stats;
654 void push_buffer_stats (uint32_t, uint32_t);
655 void write_buffer_stats ();
657 bool have_disk_speed_dialog_displayed;
658 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
659 void disk_overrun_handler ();
660 void disk_underrun_handler ();
662 void session_dialog (std::string);
663 int pending_state_dialog ();
664 int sr_mismatch_dialog (nframes_t, nframes_t);
666 void disconnect_from_jack ();
667 void reconnect_to_jack ();
668 void set_jack_buffer_size (nframes_t);
670 Gtk::MenuItem* jack_disconnect_item;
671 Gtk::MenuItem* jack_reconnect_item;
672 Gtk::Menu* jack_bufsize_menu;
674 Glib::RefPtr<Gtk::ActionGroup> common_actions;
676 void editor_realized ();
678 std::vector<std::string> positional_sync_strings;
680 void toggle_send_midi_feedback ();
681 void toggle_use_mmc ();
682 void toggle_send_mmc ();
683 void toggle_send_mtc ();
684 void toggle_send_midi_clock ();
686 void toggle_use_osc ();
688 void toggle_denormal_protection ();
690 void set_input_auto_connect (ARDOUR::AutoConnectOption);
691 void set_output_auto_connect (ARDOUR::AutoConnectOption);
692 void set_solo_model (ARDOUR::SoloModel);
693 void set_monitor_model (ARDOUR::MonitorModel);
694 void set_remote_model (ARDOUR::RemoteModel);
695 void set_denormal_model (ARDOUR::DenormalModel);
697 void toggle_sync_order_keys ();
698 void toggle_new_plugins_active();
699 void toggle_StopPluginsWithTransport();
700 void toggle_DoNotRunPluginsWhileRecording();
701 void toggle_VerifyRemoveLastCapture();
702 void toggle_PeriodicSafetyBackups();
703 void toggle_StopRecordingOnXrun();
704 void toggle_CreateXrunMarker();
705 void toggle_StopTransportAtEndOfSession();
706 void toggle_GainReduceFastTransport();
707 void toggle_LatchedSolo();
708 void toggle_ShowSoloMutes();
709 void toggle_SoloMuteOverride();
710 void toggle_LatchedRecordEnable ();
711 void toggle_RegionEquivalentsOverlap ();
712 void toggle_PrimaryClockDeltaEditCursor ();
713 void toggle_SecondaryClockDeltaEditCursor ();
714 void toggle_ShowTrackMeters ();
715 void toggle_only_copy_imported_files ();
716 void toggle_use_narrow_ms();
717 void toggle_NameNewMarkers ();
718 void toggle_rubberbanding_snaps_to_grid ();
719 void toggle_auto_analyse_audio ();
720 void toggle_TapeMachineMode();
722 void mtc_port_changed ();
723 void map_solo_model ();
724 void map_monitor_model ();
725 void map_denormal_model ();
726 void map_denormal_protection ();
727 void map_remote_model ();
728 void map_file_header_format ();
729 void map_file_data_format ();
730 void map_input_auto_connect ();
731 void map_output_auto_connect ();
732 void map_only_copy_imported_files ();
733 void parameter_changed (std::string);
735 void set_meter_hold (ARDOUR::MeterHold);
736 void set_meter_falloff (ARDOUR::MeterFalloff);
737 void map_meter_hold ();
738 void map_meter_falloff ();
740 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
741 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
745 void no_memory_warning ();
746 void check_memory_locking ();
748 bool check_audioengine();
749 void audioengine_setup ();
751 void display_message (const char *prefix, gint prefix_len,
752 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
753 Gtk::Label status_bar_label;
754 Gtk::ToggleButton error_log_button;
756 void loading_message (const std::string& msg);
757 void end_loading_messages ();
759 void platform_specific ();
760 void platform_setup ();
761 void fontconfig_dialog ();
764 #endif /* __ardour_gui_h__ */