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 "audio_clock.h"
67 #include "ardour_dialog.h"
69 #include "ui_config.h"
77 class ConnectionEditor;
79 class LocationUIWindow;
84 class SessionOptionEditor;
93 class ControlProtocolInfo;
101 extern sigc::signal<void> ColorsChanged;
102 extern sigc::signal<void> DPIReset;
104 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
107 ARDOUR_UI (int *argcp, char **argvp[]);
110 bool run_startup (bool should_be_new);
113 bool shown() { return shown_flag; }
121 void idle_load (const Glib::ustring& path);
124 int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
126 int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
128 uint32_t master_chns,
129 ARDOUR::AutoConnectOption input_connect,
130 ARDOUR::AutoConnectOption output_connect,
133 nframes_t initial_length);
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);
147 void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
148 int load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
149 int build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
150 bool ask_about_loading_existing_session (const Glib::ustring& session_path);
152 /// @return true if session was successfully unloaded.
153 int unload_session (bool hide_stuff = false);
154 void close_session();
156 int save_state_canfail (std::string state_name = "");
157 void save_state (const std::string & state_name = "");
159 static double gain_to_slider_position (ARDOUR::gain_t g);
160 static ARDOUR::gain_t slider_position_to_gain (double pos);
162 static ARDOUR_UI *instance () { return theArdourUI; }
163 static UIConfiguration *config () { return ui_config; }
165 PublicEditor& the_editor(){return *editor;}
166 Mixer_UI* the_mixer() { return mixer; }
168 void toggle_key_editor ();
169 void toggle_location_window ();
170 void toggle_theme_manager ();
171 void toggle_bundle_manager ();
172 void toggle_big_clock_window ();
173 void toggle_route_params_window ();
174 void toggle_editing_space();
176 Gtk::Tooltips& tooltips() { return _tooltips; }
178 static sigc::signal<void,bool> Blink;
179 static sigc::signal<void> RapidScreenUpdate;
180 static sigc::signal<void> SuperRapidScreenUpdate;
181 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
183 XMLNode* editor_settings() const;
184 XMLNode* mixer_settings () const;
185 XMLNode* keyboard_settings () const;
187 void save_ardour_state ();
188 gboolean configure_handler (GdkEventConfigure* conf);
190 void do_transport_locate (nframes_t position);
191 void halt_on_xrun_message ();
192 void xrun_handler (nframes_t);
193 void create_xrun_marker (nframes_t);
195 AudioClock primary_clock;
196 AudioClock secondary_clock;
197 AudioClock preroll_clock;
198 AudioClock postroll_clock;
200 void store_clock_modes ();
201 void restore_clock_modes ();
202 void reset_main_clocks ();
204 void add_route (Gtk::Window* float_window);
206 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, ARDOUR::RouteGroup* route_group, uint32_t how_many) {
207 session_add_audio_route (true, false, input_channels, output_channels, mode, route_group, how_many);
210 void session_add_audio_bus (bool aux, int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group, uint32_t how_many) {
211 session_add_audio_route (false, aux, input_channels, output_channels, ARDOUR::Normal, route_group, how_many);
214 void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many) {
215 session_add_midi_route (true, route_group, how_many);
218 /*void session_add_midi_bus () {
219 session_add_midi_route (false);
222 int create_engine ();
225 gint exit_on_main_window_close (GdkEventAny *);
227 void maximise_editing_space ();
228 void restore_editing_space ();
230 void setup_profile ();
233 void set_shuttle_fract (double);
236 friend class PublicEditor;
238 void toggle_clocking ();
239 void toggle_auto_play ();
240 void toggle_auto_input ();
241 void toggle_punch ();
242 void unset_dual_punch ();
243 bool ignore_dual_punch;
244 void toggle_punch_in ();
245 void toggle_punch_out ();
246 void show_loop_punch_ruler_and_disallow_hide ();
247 void reenable_hide_loop_punch_ruler_if_appropriate ();
248 void toggle_auto_return ();
249 void toggle_click ();
251 void toggle_session_auto_loop ();
253 void toggle_rc_options_window ();
254 void toggle_session_options_window ();
257 ArdourStartup* _startup;
258 ARDOUR::AudioEngine *engine;
259 Gtk::Tooltips _tooltips;
261 void goto_editor_window ();
262 void goto_mixer_window ();
263 void toggle_editor_mixer_on_top ();
266 Gtk::ToggleButton preroll_button;
267 Gtk::ToggleButton postroll_button;
269 int setup_windows ();
270 void setup_transport ();
273 static ARDOUR_UI *theArdourUI;
275 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
279 int ask_about_saving_session (const std::string & why);
281 /* periodic safety backup, to be precise */
282 gint autosave_session();
283 void update_autosave();
284 sigc::connection _autosave_connection;
286 void map_transport_state ();
287 int32_t do_engine_start ();
289 void engine_halted ();
290 void engine_stopped ();
291 void engine_running ();
295 static gint _blink (void *);
297 gint blink_timeout_tag;
299 void start_blinking ();
300 void stop_blinking ();
302 void about_signal_response(int response);
305 Gtk::VBox top_packer;
307 sigc::connection clock_signal_connection;
308 void update_clocks ();
309 void start_clocking ();
310 void stop_clocking ();
312 void manage_window (Gtk::Window&);
314 AudioClock big_clock;
315 Gtk::Window* big_clock_window;
317 void float_big_clock (Gtk::Window* parent);
318 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
320 void update_transport_clocks (nframes_t pos);
321 void record_state_changed ();
323 /* Transport Control */
325 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
326 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
328 Gtkmm2ext::TearOff* transport_tearoff;
329 Gtk::Frame transport_frame;
330 Gtk::HBox transport_tearoff_hbox;
331 Gtk::HBox play_range_hbox;
332 Gtk::VBox play_range_vbox;
333 Gtk::HBox transport_hbox;
334 Gtk::Fixed transport_base;
335 Gtk::Fixed transport_button_base;
336 Gtk::Frame transport_button_frame;
337 Gtk::HBox transport_button_hbox;
338 Gtk::VBox transport_button_vbox;
339 Gtk::HBox transport_option_button_hbox;
340 Gtk::VBox transport_option_button_vbox;
341 Gtk::HBox transport_clock_hbox;
342 Gtk::VBox transport_clock_vbox;
343 Gtk::HBox primary_clock_hbox;
344 Gtk::HBox secondary_clock_hbox;
347 struct TransportControllable : public PBD::Controllable {
360 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
361 void set_value (float);
362 float get_value (void) const;
364 void set_id (const std::string&);
370 boost::shared_ptr<TransportControllable> roll_controllable;
371 boost::shared_ptr<TransportControllable> stop_controllable;
372 boost::shared_ptr<TransportControllable> goto_start_controllable;
373 boost::shared_ptr<TransportControllable> goto_end_controllable;
374 boost::shared_ptr<TransportControllable> auto_loop_controllable;
375 boost::shared_ptr<TransportControllable> play_selection_controllable;
376 boost::shared_ptr<TransportControllable> rec_controllable;
377 boost::shared_ptr<TransportControllable> shuttle_controllable;
378 BindingProxy shuttle_controller_binding_proxy;
380 void set_transport_controllable_state (const XMLNode&);
381 XMLNode& get_transport_controllable_state ();
383 BindableButton roll_button;
384 BindableButton stop_button;
385 BindableButton goto_start_button;
386 BindableButton goto_end_button;
387 BindableButton auto_loop_button;
388 BindableButton play_selection_button;
389 BindableButton rec_button;
390 Gtk::ToggleButton join_play_range_button;
392 void toggle_external_sync ();
393 void toggle_time_master ();
394 void toggle_video_sync ();
396 Gtk::DrawingArea shuttle_box;
397 Gtk::EventBox speed_display_box;
398 Gtk::Label speed_display_label;
399 Gtk::Button shuttle_units_button;
400 Gtk::ComboBoxText shuttle_style_button;
401 Gtk::Menu* shuttle_unit_menu;
402 Gtk::Menu* shuttle_style_menu;
403 float shuttle_max_speed;
404 Gtk::Menu* shuttle_context_menu;
406 void build_shuttle_context_menu ();
407 void show_shuttle_context_menu ();
408 void shuttle_style_changed();
409 void shuttle_unit_clicked ();
410 void set_shuttle_max_speed (float);
411 void update_speed_display ();
412 float last_speed_displayed;
414 gint shuttle_box_button_press (GdkEventButton*);
415 gint shuttle_box_button_release (GdkEventButton*);
416 gint shuttle_box_scroll (GdkEventScroll*);
417 gint shuttle_box_motion (GdkEventMotion*);
418 gint shuttle_box_expose (GdkEventExpose*);
419 gint mouse_shuttle (double x, bool force);
420 void use_shuttle_fract (bool force);
422 bool shuttle_grabbed;
423 double shuttle_fract;
425 Gtkmm2ext::StatefulToggleButton punch_in_button;
426 Gtkmm2ext::StatefulToggleButton punch_out_button;
427 Gtkmm2ext::StatefulToggleButton auto_return_button;
428 Gtkmm2ext::StatefulToggleButton auto_play_button;
429 Gtkmm2ext::StatefulToggleButton auto_input_button;
430 Gtkmm2ext::StatefulToggleButton click_button;
431 Gtkmm2ext::StatefulToggleButton time_master_button;
432 Gtkmm2ext::StatefulToggleButton sync_button;
434 Gtk::ToggleButton auditioning_alert_button;
435 Gtk::ToggleButton solo_alert_button;
439 void solo_blink (bool);
440 void sync_blink (bool);
441 void audition_blink (bool);
443 void soloing_changed (bool);
444 void auditioning_changed (bool);
445 void _auditioning_changed (bool);
447 void solo_alert_toggle ();
448 void audition_alert_toggle ();
450 void big_clock_value_changed ();
451 void primary_clock_value_changed ();
452 void secondary_clock_value_changed ();
454 /* called by Blink signal */
456 void transport_rec_enable_blink (bool onoff);
458 Gtk::Menu* session_popup_menu;
460 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
461 RecentSessionModelColumns() {
465 Gtk::TreeModelColumn<Glib::ustring> visible_name;
466 Gtk::TreeModelColumn<Glib::ustring> fullpath;
469 RecentSessionModelColumns recent_session_columns;
470 Gtk::TreeView recent_session_display;
471 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
473 ArdourDialog* session_selector_window;
474 Gtk::FileChooserDialog* open_session_selector;
476 void build_session_selector();
477 void redisplay_recent_sessions();
478 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
480 struct RecentSessionsSorter {
481 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
482 return cmp_nocase(a.first, b.first) == -1;
486 /* menu bar and associated stuff */
488 Gtk::MenuBar* menu_bar;
489 Gtk::EventBox menu_bar_base;
492 void use_menubar_as_top_menubar ();
493 void build_menu_bar ();
495 Gtk::Label wall_clock_label;
496 Gtk::EventBox wall_clock_box;
497 gint update_wall_clock ();
499 Gtk::Label disk_space_label;
500 Gtk::EventBox disk_space_box;
501 void update_disk_space ();
503 Gtk::Label cpu_load_label;
504 Gtk::EventBox cpu_load_box;
505 void update_cpu_load ();
507 Gtk::Label buffer_load_label;
508 Gtk::EventBox buffer_load_box;
509 void update_buffer_load ();
511 Gtk::Label sample_rate_label;
512 Gtk::EventBox sample_rate_box;
513 void update_sample_rate (nframes_t);
515 gint every_second ();
516 gint every_point_one_seconds ();
517 gint every_point_zero_one_seconds ();
519 sigc::connection second_connection;
520 sigc::connection point_one_second_connection;
521 sigc::connection point_oh_five_second_connection;
522 sigc::connection point_zero_one_second_connection;
524 gint session_menu (GdkEventButton *);
526 bool _will_create_new_session_automatically;
528 void open_session ();
529 void open_recent_session ();
530 void save_template ();
532 void edit_metadata ();
533 void import_metadata ();
535 void session_add_audio_route (bool disk, bool aux, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, ARDOUR::RouteGroup *, uint32_t how_many);
536 void session_add_midi_route (bool disk, ARDOUR::RouteGroup *, uint32_t how_many);
538 void set_transport_sensitivity (bool);
540 void remove_last_capture ();
542 void transport_goto_zero ();
543 void transport_goto_start ();
544 void transport_goto_end ();
545 void transport_goto_wallclock ();
546 void transport_stop ();
547 void transport_stop_and_forget_capture ();
548 void transport_record (bool roll);
549 void transport_roll ();
550 void transport_play_selection();
551 void transport_forward (int option);
552 void transport_rewind (int option);
553 void transport_loop ();
554 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
556 bool _session_is_new;
557 void set_session (ARDOUR::Session *);
558 void connect_dependents_to_session (ARDOUR::Session *);
559 void we_have_dependents ();
561 void setup_session_options ();
563 guint32 last_key_press_time;
565 void snapshot_session ();
570 PublicEditor *editor;
571 int create_editor ();
573 RouteParams_UI *route_params;
574 int create_route_params ();
576 BundleManager *bundle_manager;
577 void create_bundle_manager ();
579 LocationUIWindow *location_ui;
580 int create_location_ui ();
581 void handle_locations_change (ARDOUR::Location*);
583 static UIConfiguration *ui_config;
584 ThemeManager *theme_manager;
586 /* Key bindings editor */
588 KeyEditor *key_editor;
590 /* RC Options window */
592 RCOptionEditor *rc_option_editor;
594 SessionOptionEditor *session_option_editor;
598 AddRouteDialog *add_route_dialog;
600 /* Keyboard Handling */
602 ArdourKeyboard* keyboard;
604 /* Keymap handling */
606 void install_actions ();
608 void toggle_record_enable (uint32_t);
610 uint32_t rec_enabled_streams;
611 void count_recenabled_streams (ARDOUR::Route&);
615 void pop_back_splash ();
620 Gtk::MenuItem *cleanup_item;
622 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title,
623 const std::string& plural_msg, const std::string& singular_msg);
627 bool have_configure_timeout;
628 ARDOUR::microseconds_t last_configure_time;
629 gint configure_timeout ();
631 ARDOUR::microseconds_t last_peak_grab;
632 ARDOUR::microseconds_t last_shuttle_request;
634 struct DiskBufferStat {
639 DiskBufferStat (time_t w, uint32_t c, uint32_t p)
640 : when (w), capture (c), playback (p) {}
643 std::list<DiskBufferStat> disk_buffer_stats;
644 void push_buffer_stats (uint32_t, uint32_t);
645 void write_buffer_stats ();
647 bool have_disk_speed_dialog_displayed;
648 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
649 void disk_overrun_handler ();
650 void disk_underrun_handler ();
652 void session_dialog (std::string);
653 int pending_state_dialog ();
654 int sr_mismatch_dialog (nframes_t, nframes_t);
656 void disconnect_from_jack ();
657 void reconnect_to_jack ();
658 void set_jack_buffer_size (nframes_t);
660 Gtk::MenuItem* jack_disconnect_item;
661 Gtk::MenuItem* jack_reconnect_item;
662 Gtk::Menu* jack_bufsize_menu;
664 Glib::RefPtr<Gtk::ActionGroup> common_actions;
666 void editor_realized ();
668 std::vector<std::string> positional_sync_strings;
670 void toggle_send_midi_feedback ();
671 void toggle_use_mmc ();
672 void toggle_send_mmc ();
673 void toggle_send_mtc ();
674 void toggle_send_midi_clock ();
676 void toggle_use_osc ();
678 void parameter_changed (std::string);
682 void no_memory_warning ();
683 void check_memory_locking ();
685 bool check_audioengine();
686 void audioengine_setup ();
688 void display_message (const char *prefix, gint prefix_len,
689 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
691 Gtk::Label status_bar_label;
692 Gtk::ToggleButton error_log_button;
694 void loading_message (const std::string& msg);
695 void end_loading_messages ();
697 void platform_specific ();
698 void platform_setup ();
699 void fontconfig_dialog ();
701 PBD::ScopedConnectionList forever_connections;
704 #endif /* __ardour_gui_h__ */