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__
23 /* need _BSD_SOURCE to get timersub macros */
37 #include <libgnomecanvasmm/canvas.h>
39 #include <pbd/xml++.h>
40 #include <gtkmm/box.h>
41 #include <gtkmm/frame.h>
42 #include <gtkmm/label.h>
43 #include <gtkmm/table.h>
44 #include <gtkmm/fixed.h>
45 #include <gtkmm/drawingarea.h>
46 #include <gtkmm/eventbox.h>
47 #include <gtkmm/menu.h>
48 #include <gtkmm/menuitem.h>
49 #include <gtkmm/button.h>
50 #include <gtkmm/togglebutton.h>
51 #include <gtkmm/treeview.h>
52 #include <gtkmm/menubar.h>
53 #include <gtkmm/adjustment.h>
54 #include <gtkmm2ext/gtk_ui.h>
55 #include <gtkmm2ext/click_box.h>
56 #include <gtkmm2ext/stateful_button.h>
57 #include <gtkmm2ext/bindable_button.h>
58 #include <ardour/ardour.h>
59 #include <ardour/session.h>
61 #include "audio_clock.h"
62 #include "ardour_dialog.h"
70 class ConnectionEditor;
74 class NewSessionDialog;
87 class ControlProtocolInfo;
91 class MultiChannelDevice;
94 #define FRAME_NAME "BaseFrame"
96 class ARDOUR_UI : public Gtkmm2ext::UI
99 ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
103 bool shown() { return shown_flag; }
108 int load_session (const string & path, const string & snapshot, string* mix_template = 0);
110 int build_session (const string & path, const string & snapshot,
112 uint32_t master_chns,
113 ARDOUR::AutoConnectOption input_connect,
114 ARDOUR::AutoConnectOption output_connect,
117 nframes_t initial_length);
118 bool session_is_new() const { return _session_is_new; }
120 ARDOUR::Session* the_session() { return session; }
122 bool will_create_new_session_automatically() const {
123 return _will_create_new_session_automatically;
126 void set_will_create_new_session_automatically (bool yn) {
127 _will_create_new_session_automatically = yn;
130 void new_session(std::string path = string());
131 gint cmdline_new_session (string path);
132 int unload_session ();
133 void close_session();
135 int save_state_canfail (string state_name = "");
136 void save_state (const string & state_name = "");
137 void restore_state (string state_name = "");
139 static double gain_to_slider_position (ARDOUR::gain_t g);
140 static ARDOUR::gain_t slider_position_to_gain (double pos);
142 static ARDOUR_UI *instance () { return theArdourUI; }
144 PublicEditor& the_editor(){return *editor;}
145 Mixer_UI* the_mixer() { return mixer; }
147 void toggle_location_window ();
148 void toggle_color_manager ();
149 void toggle_big_clock_window ();
150 void toggle_connection_editor ();
151 void toggle_route_params_window ();
152 void toggle_editing_space();
154 Gtk::Tooltips& tooltips() { return _tooltips; }
156 static sigc::signal<void,bool> Blink;
157 static sigc::signal<void> RapidScreenUpdate;
158 static sigc::signal<void> MidRapidScreenUpdate;
159 static sigc::signal<void> SuperRapidScreenUpdate;
160 static sigc::signal<void,nframes_t> Clock;
162 /* this is a helper function to centralize the (complex) logic for
163 blinking rec-enable buttons.
166 void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
168 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
170 static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
172 XMLNode* editor_settings() const;
173 XMLNode* mixer_settings () const;
174 XMLNode* keyboard_settings () const;
176 void save_ardour_state ();
177 gboolean configure_handler (GdkEventConfigure* conf);
179 void do_transport_locate (nframes_t position);
180 void halt_on_xrun_message ();
182 AudioClock primary_clock;
183 AudioClock secondary_clock;
184 AudioClock preroll_clock;
185 AudioClock postroll_clock;
187 void store_clock_modes ();
188 void restore_clock_modes ();
190 void add_route (Gtk::Window* float_window);
192 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
193 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
196 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
197 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
200 void session_add_midi_track ();
202 void set_engine (ARDOUR::AudioEngine&);
203 gint start_engine ();
205 gint exit_on_main_window_close (GdkEventAny *);
207 void maximise_editing_space ();
208 void restore_editing_space ();
210 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
211 void set_native_file_data_format (ARDOUR::SampleFormat sf);
213 void set_keybindings_path (std::string path);
214 void save_keybindings ();
217 friend class PublicEditor;
219 void toggle_clocking ();
220 void toggle_auto_play ();
221 void toggle_auto_input ();
222 void toggle_punch_in ();
223 void toggle_punch_out ();
224 void toggle_auto_return ();
225 void toggle_click ();
227 void toggle_session_auto_loop ();
229 void toggle_options_window ();
232 struct GlobalClickBox : public Gtk::VBox {
233 Gtkmm2ext::ClickBox *box;
236 vector<string> &strings;
237 Gtk::Adjustment adjustment;
239 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
241 GlobalClickBox (const string &str, vector<string> &vs)
243 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
244 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
245 label.set_text (str);
246 label.set_name ("GlobalButtonLabel");
248 frame.set_shadow_type (Gtk::SHADOW_IN);
251 box->set_print_func (printer, this);
252 box->set_wrap (true);
256 ARDOUR::AudioEngine *engine;
257 ARDOUR::Session *session;
259 Gtk::Tooltips _tooltips;
261 void goto_editor_window ();
262 void goto_mixer_window ();
264 Gtk::Table adjuster_table;
265 Gtk::Frame adjuster_frame;
266 Gtk::Fixed adjuster_base;
268 GlobalClickBox *online_control_button;
269 vector<string> online_control_strings;
271 GlobalClickBox *crossfade_time_button;
272 vector<string> crossfade_time_strings;
274 Gtk::ToggleButton preroll_button;
275 Gtk::ToggleButton postroll_button;
277 Gtk::Table transport_table;
278 Gtk::Table option_table;
280 int setup_windows ();
281 void setup_transport ();
284 static ARDOUR_UI *theArdourUI;
290 int ask_about_saving_session (const string & why);
291 int save_the_session;
293 void queue_transport_change ();
294 void map_transport_state ();
295 int32_t do_engine_start ();
297 void engine_halted ();
298 void engine_stopped ();
299 void engine_running ();
303 static gint _blink (void *);
305 gint blink_timeout_tag;
307 void start_blinking ();
308 void stop_blinking ();
310 void about_signal_response(int response);
313 Gtk::VBox top_packer;
315 sigc::connection clock_signal_connection;
316 void update_clocks ();
317 void start_clocking ();
318 void stop_clocking ();
320 void manage_window (Gtk::Window&);
322 AudioClock big_clock;
323 Gtk::Frame big_clock_frame;
324 Gtk::Window* big_clock_window;
326 void update_transport_clocks (nframes_t pos);
327 void record_state_changed ();
329 /* Transport Control */
331 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
332 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
334 Gtkmm2ext::TearOff* transport_tearoff;
335 Gtk::Frame transport_frame;
336 Gtk::HBox transport_tearoff_hbox;
337 Gtk::HBox transport_hbox;
338 Gtk::Fixed transport_base;
339 Gtk::Fixed transport_button_base;
340 Gtk::Frame transport_button_frame;
341 Gtk::HBox transport_button_hbox;
342 Gtk::VBox transport_button_vbox;
343 Gtk::HBox transport_option_button_hbox;
344 Gtk::VBox transport_option_button_vbox;
345 Gtk::HBox transport_clock_hbox;
346 Gtk::VBox transport_clock_vbox;
347 Gtk::HBox primary_clock_hbox;
348 Gtk::HBox secondary_clock_hbox;
351 struct TransportControllable : public PBD::Controllable {
364 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
365 void set_value (float);
366 float get_value (void) const;
368 void set_id (const std::string&);
374 TransportControllable roll_controllable;
375 TransportControllable stop_controllable;
376 TransportControllable goto_start_controllable;
377 TransportControllable goto_end_controllable;
378 TransportControllable auto_loop_controllable;
379 TransportControllable play_selection_controllable;
380 TransportControllable rec_controllable;
381 TransportControllable shuttle_controllable;
382 BindingProxy shuttle_controller_binding_proxy;
384 void set_transport_controllable_state (const XMLNode&);
385 XMLNode& get_transport_controllable_state ();
387 BindableButton roll_button;
388 BindableButton stop_button;
389 BindableButton goto_start_button;
390 BindableButton goto_end_button;
391 BindableButton auto_loop_button;
392 BindableButton play_selection_button;
393 BindableButton rec_button;
395 Gtk::ComboBoxText sync_option_combo;
397 void sync_option_changed ();
398 void toggle_time_master ();
399 void toggle_video_sync ();
401 Gtk::DrawingArea shuttle_box;
402 Gtk::EventBox speed_display_box;
403 Gtk::Label speed_display_label;
404 Gtk::Button shuttle_units_button;
405 Gtk::ComboBoxText shuttle_style_button;
406 Gtk::Menu* shuttle_unit_menu;
407 Gtk::Menu* shuttle_style_menu;
408 float shuttle_max_speed;
409 Gtk::Menu* shuttle_context_menu;
411 void build_shuttle_context_menu ();
412 void show_shuttle_context_menu ();
413 void shuttle_style_changed();
414 void shuttle_unit_clicked ();
415 void set_shuttle_max_speed (float);
416 void update_speed_display ();
417 float last_speed_displayed;
419 gint shuttle_box_button_press (GdkEventButton*);
420 gint shuttle_box_button_release (GdkEventButton*);
421 gint shuttle_box_scroll (GdkEventScroll*);
422 gint shuttle_box_motion (GdkEventMotion*);
423 gint shuttle_box_expose (GdkEventExpose*);
424 gint mouse_shuttle (double x, bool force);
425 void use_shuttle_fract (bool force);
426 void set_shuttle_fract (double);
428 bool shuttle_grabbed;
429 double shuttle_fract;
431 Gtkmm2ext::StatefulToggleButton punch_in_button;
432 Gtkmm2ext::StatefulToggleButton punch_out_button;
433 Gtkmm2ext::StatefulToggleButton auto_return_button;
434 Gtkmm2ext::StatefulToggleButton auto_play_button;
435 Gtkmm2ext::StatefulToggleButton auto_input_button;
436 Gtkmm2ext::StatefulToggleButton click_button;
437 Gtkmm2ext::StatefulToggleButton time_master_button;
439 Gtk::ToggleButton auditioning_alert_button;
440 Gtk::ToggleButton solo_alert_button;
444 void solo_blink (bool);
445 void audition_blink (bool);
447 void soloing_changed (bool);
448 void auditioning_changed (bool);
449 void _auditioning_changed (bool);
451 void solo_alert_toggle ();
452 void audition_alert_toggle ();
454 void primary_clock_value_changed ();
455 void secondary_clock_value_changed ();
457 /* called by Blink signal */
459 void transport_rec_enable_blink (bool onoff);
461 Gtk::Menu* session_popup_menu;
463 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
464 RecentSessionModelColumns() {
468 Gtk::TreeModelColumn<Glib::ustring> visible_name;
469 Gtk::TreeModelColumn<Glib::ustring> fullpath;
472 RecentSessionModelColumns recent_session_columns;
473 Gtk::TreeView recent_session_display;
474 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
476 ArdourDialog* session_selector_window;
477 Gtk::FileChooserDialog* open_session_selector;
479 void build_session_selector();
480 void redisplay_recent_sessions();
481 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
483 struct RecentSessionsSorter {
484 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
485 return cmp_nocase(a.first, b.first) == -1;
489 /* menu bar and associated stuff */
491 Gtk::MenuBar* menu_bar;
492 Gtk::EventBox menu_bar_base;
495 void build_menu_bar ();
496 void build_control_surface_menu ();
498 Gtk::Label wall_clock_label;
499 Gtk::EventBox wall_clock_box;
500 gint update_wall_clock ();
502 Gtk::Label disk_space_label;
503 Gtk::EventBox disk_space_box;
504 void update_disk_space ();
506 Gtk::Label cpu_load_label;
507 Gtk::EventBox cpu_load_box;
508 void update_cpu_load ();
510 Gtk::Label buffer_load_label;
511 Gtk::EventBox buffer_load_box;
512 void update_buffer_load ();
514 Gtk::Label sample_rate_label;
515 Gtk::EventBox sample_rate_box;
516 void update_sample_rate (nframes_t);
518 gint every_second ();
519 gint every_point_one_seconds ();
520 gint every_point_oh_five_seconds ();
521 gint every_point_zero_one_seconds ();
523 sigc::connection second_connection;
524 sigc::connection point_one_second_connection;
525 sigc::connection point_oh_five_second_connection;
526 sigc::connection point_zero_one_second_connection;
528 gint session_menu (GdkEventButton *);
530 bool _will_create_new_session_automatically;
532 NewSessionDialog* new_session_dialog;
534 void open_session ();
535 void open_recent_session ();
536 void save_template ();
538 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
540 void set_transport_sensitivity (bool);
542 void remove_last_capture ();
544 void transport_goto_zero ();
545 void transport_goto_start ();
546 void transport_goto_end ();
547 void transport_stop ();
548 void transport_stop_and_forget_capture ();
549 void transport_record ();
550 void transport_roll ();
551 void transport_play_selection();
552 void transport_forward (int option);
553 void transport_rewind (int option);
554 void transport_loop ();
556 void transport_rolling ();
557 void transport_rewinding ();
558 void transport_forwarding ();
559 void transport_stopped ();
561 bool _session_is_new;
562 void connect_to_session (ARDOUR::Session *);
563 void connect_dependents_to_session (ARDOUR::Session *);
564 void we_have_dependents ();
566 std::string keybindings_path;
568 void setup_keybindings ();
569 void setup_session_options ();
571 guint32 last_key_press_time;
573 void snapshot_session ();
578 PublicEditor *editor;
579 int create_editor ();
581 RouteParams_UI *route_params;
582 int create_route_params ();
584 ConnectionEditor *connection_editor;
585 int create_connection_editor ();
587 LocationUI *location_ui;
588 int create_location_ui ();
589 void handle_locations_change (ARDOUR::Location*);
591 ColorManager* color_manager;
595 OptionEditor *option_editor;
599 AddRouteDialog *add_route_dialog;
601 /* Keyboard Handling */
605 /* Keymap handling */
607 void install_actions ();
609 void toggle_record_enable (uint32_t);
611 uint32_t rec_enabled_streams;
612 void count_recenabled_streams (ARDOUR::Route&);
618 Gtk::MenuItem *cleanup_item;
620 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
624 bool have_configure_timeout;
625 struct timeval last_configure_time;
626 gint configure_timeout ();
628 struct timeval last_peak_grab;
629 struct timeval last_shuttle_request;
631 bool have_disk_speed_dialog_displayed;
632 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
633 void disk_overrun_handler ();
634 void disk_underrun_handler ();
636 int pending_state_dialog ();
638 void disconnect_from_jack ();
639 void reconnect_to_jack ();
640 void set_jack_buffer_size (nframes_t);
642 Gtk::MenuItem* jack_disconnect_item;
643 Gtk::MenuItem* jack_reconnect_item;
644 Gtk::Menu* jack_bufsize_menu;
646 int make_session_clean ();
647 bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
649 Glib::RefPtr<Gtk::ActionGroup> common_actions;
651 void editor_realized ();
653 std::vector<std::string> positional_sync_strings;
655 void toggle_send_midi_feedback ();
656 void toggle_use_mmc ();
657 void toggle_send_mmc ();
658 void toggle_use_midi_control();
659 void toggle_send_mtc ();
661 void toggle_use_osc ();
663 void set_input_auto_connect (ARDOUR::AutoConnectOption);
664 void set_output_auto_connect (ARDOUR::AutoConnectOption);
665 void set_solo_model (ARDOUR::SoloModel);
666 void set_monitor_model (ARDOUR::MonitorModel);
667 void set_remote_model (ARDOUR::RemoteModel);
669 void toggle_StopPluginsWithTransport();
670 void toggle_DoNotRunPluginsWhileRecording();
671 void toggle_VerifyRemoveLastCapture();
672 void toggle_StopRecordingOnXrun();
673 void toggle_StopTransportAtEndOfSession();
674 void toggle_GainReduceFastTransport();
675 void toggle_LatchedSolo();
676 void toggle_ShowSoloMutes();
677 void toggle_LatchedRecordEnable ();
678 void toggle_RegionEquivalentsOverlap ();
680 void mtc_port_changed ();
681 void map_solo_model ();
682 void map_monitor_model ();
683 void map_remote_model ();
684 void map_file_header_format ();
685 void map_file_data_format ();
686 void map_input_auto_connect ();
687 void map_output_auto_connect ();
688 void parameter_changed (const char*);
690 void set_meter_hold (ARDOUR::MeterHold);
691 void set_meter_falloff (ARDOUR::MeterFalloff);
692 void map_meter_hold ();
693 void map_meter_falloff ();
695 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
696 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
698 bool can_save_keybindings;
701 void no_memory_warning ();
702 void check_memory_locking ();
705 #endif /* __ardour_gui_h__ */