add new A/B comparison for plugins, plus ways of disabling all plugins quickly (not...
[ardour.git] / gtk2_ardour / ardour_ui.h
1 /*
2     Copyright (C) 1999-2002 Paul Davis 
3
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.
8
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.
13
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.
17
18 */
19
20 #ifndef __ardour_gui_h__
21 #define __ardour_gui_h__
22
23 /* need _BSD_SOURCE to get timersub macros */
24
25 #ifdef _BSD_SOURCE
26 #include <sys/time.h>
27 #else
28 #define _BSD_SOURCE
29 #include <sys/time.h>
30 #undef _BSD_SOURCE
31 #endif
32
33 #include <list>
34
35 #include <cmath>
36
37 #include <libgnomecanvasmm/canvas.h>
38
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>
60
61 #include "audio_clock.h"
62 #include "ardour_dialog.h"
63 #include "editing.h"
64
65 class AudioClock;
66 class PublicEditor;
67 class Keyboard;
68 class OptionEditor;
69 class Mixer_UI;
70 class ConnectionEditor;
71 class RouteParams_UI;
72 class About;
73 class AddRouteDialog;
74 class NewSessionDialog;
75 class LocationUI;
76 class ColorManager;
77
78 namespace Gtkmm2ext {
79         class TearOff;
80 }
81
82 namespace ARDOUR {
83         class AudioEngine;
84         class Route;
85         class Port;
86         class IO;
87         class ControlProtocolInfo;
88 }
89
90 namespace ALSA {
91         class MultiChannelDevice;
92 }
93
94 #define FRAME_NAME "BaseFrame"
95
96 class ARDOUR_UI : public Gtkmm2ext::UI
97 {
98   public:
99         ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
100         ~ARDOUR_UI();
101
102         void show ();
103         bool shown() { return shown_flag; }
104         
105         void show_splash ();
106         void hide_splash ();
107         
108         int load_session (const string & path, const string & snapshot, string* mix_template = 0);
109         bool session_loaded;
110         int build_session (const string & path, const string & snapshot, 
111                            uint32_t ctl_chns, 
112                            uint32_t master_chns,
113                            ARDOUR::AutoConnectOption input_connect,
114                            ARDOUR::AutoConnectOption output_connect,
115                            uint32_t nphysin,
116                            uint32_t nphysout,
117                            nframes_t initial_length);
118         bool session_is_new() const { return _session_is_new; }
119
120         ARDOUR::Session* the_session() { return session; }
121
122         bool will_create_new_session_automatically() const {
123                 return _will_create_new_session_automatically;
124         }
125
126         void set_will_create_new_session_automatically (bool yn) {
127                 _will_create_new_session_automatically = yn;
128         }
129
130         bool new_session(std::string path = string());
131         gint cmdline_new_session (string path);
132         int  unload_session ();
133         void close_session(); 
134
135         int  save_state_canfail (string state_name = "");
136         void save_state (const string & state_name = "");
137         void restore_state (string state_name = "");
138
139         static double gain_to_slider_position (ARDOUR::gain_t g);
140         static ARDOUR::gain_t slider_position_to_gain (double pos);
141
142         static ARDOUR_UI *instance () { return theArdourUI; }
143
144         PublicEditor&     the_editor(){return *editor;}
145         Mixer_UI* the_mixer() { return mixer; }
146         
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();
153
154         Gtk::Tooltips& tooltips() { return _tooltips; }
155
156         static sigc::signal<void,bool> Blink;
157         static sigc::signal<void>      RapidScreenUpdate;
158         static sigc::signal<void>      SuperRapidScreenUpdate;
159         static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
160
161         /* this is a helper function to centralize the (complex) logic for
162            blinking rec-enable buttons.
163         */
164
165         void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
166
167         void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
168
169         static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
170
171         XMLNode* editor_settings() const;
172         XMLNode* mixer_settings () const;
173         XMLNode* keyboard_settings () const;
174
175         void save_ardour_state ();
176         gboolean configure_handler (GdkEventConfigure* conf);
177
178         void do_transport_locate (nframes_t position);
179         void halt_on_xrun_message ();
180
181         AudioClock primary_clock;
182         AudioClock secondary_clock;
183         AudioClock preroll_clock;
184         AudioClock postroll_clock;
185
186         void store_clock_modes ();
187         void restore_clock_modes ();
188
189         void add_route (Gtk::Window* float_window);
190         
191         void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
192                 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
193         }
194
195         void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
196                 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
197         }
198
199         void session_add_midi_track (uint32_t how_many) {
200                 session_add_midi_route (true, how_many);
201         }
202
203         /*void session_add_midi_bus () {
204                 session_add_midi_route (false);
205         }*/
206
207         void set_engine (ARDOUR::AudioEngine&);
208         gint start_engine ();
209
210         gint exit_on_main_window_close (GdkEventAny *);
211
212         void maximise_editing_space ();
213         void restore_editing_space ();
214
215         void set_native_file_header_format (ARDOUR::HeaderFormat sf);
216         void set_native_file_data_format (ARDOUR::SampleFormat sf);
217
218         void set_keybindings_path (std::string path);
219         void save_keybindings ();
220
221         void setup_profile ();
222
223   protected:
224         friend class PublicEditor;
225
226         void toggle_clocking ();
227         void toggle_auto_play ();
228         void toggle_auto_input ();
229         void toggle_punch_in ();
230         void toggle_punch_out ();
231         void toggle_auto_return ();
232         void toggle_click ();
233
234         void toggle_session_auto_loop ();
235         
236         void toggle_options_window ();
237
238   private:
239         struct GlobalClickBox : public Gtk::VBox {
240             Gtkmm2ext::ClickBox  *box;
241             Gtk::Frame      frame;
242             Gtk::Label      label;
243             vector<string> &strings;
244             Gtk::Adjustment adjustment;
245
246             static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
247
248             GlobalClickBox (const string &str, vector<string> &vs)
249                     : strings (vs),
250                       adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
251                     box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
252                     label.set_text (str);
253                     label.set_name ("GlobalButtonLabel");
254                     frame.add (*box);
255                     frame.set_shadow_type (Gtk::SHADOW_IN);
256                     pack_start (label);
257                     pack_start (frame);
258                     box->set_print_func (printer, this);
259                     box->set_wrap (true);
260             };
261         };
262
263         ARDOUR::AudioEngine                 *engine;
264         ARDOUR::Session                     *session;
265
266         bool check_audioengine();
267
268         Gtk::Tooltips          _tooltips;
269
270         void                     goto_editor_window ();
271         void                     goto_mixer_window ();
272         
273         Gtk::Table               adjuster_table;
274         Gtk::Frame               adjuster_frame;
275         Gtk::Fixed               adjuster_base;
276
277         GlobalClickBox     *online_control_button;
278         vector<string>      online_control_strings;
279
280         GlobalClickBox    *crossfade_time_button;
281         vector<string>     crossfade_time_strings;
282
283         Gtk::ToggleButton   preroll_button;
284         Gtk::ToggleButton   postroll_button;
285
286         Gtk::Table          transport_table;
287         Gtk::Table          option_table;
288
289         int  setup_windows ();
290         void setup_transport ();
291         void setup_clock ();
292
293         static ARDOUR_UI *theArdourUI;
294
295         void startup ();
296         void shutdown ();
297
298         void finish();
299         int  ask_about_saving_session (const string & why);
300         int  save_the_session;
301
302         /* periodic safety backup, to be precise */
303         gint autosave_session();
304         void update_autosave();
305         sigc::connection _autosave_connection;
306
307         void queue_transport_change ();
308         void map_transport_state ();
309         int32_t do_engine_start ();
310         
311         void engine_halted ();
312         void engine_stopped ();
313         void engine_running ();
314
315         void use_config ();
316
317         static gint _blink  (void *);
318         void blink ();
319         gint blink_timeout_tag;
320         bool blink_on;
321         void start_blinking ();
322         void stop_blinking ();
323
324         void about_signal_response(int response);
325
326   private:
327         Gtk::VBox     top_packer;
328
329         sigc::connection clock_signal_connection;
330         void         update_clocks ();
331         void         start_clocking ();
332         void         stop_clocking ();
333
334         void manage_window (Gtk::Window&);
335         
336         AudioClock   big_clock;
337         Gtk::Frame   big_clock_frame;
338         Gtk::Window* big_clock_window;
339
340         void update_transport_clocks (nframes_t pos);
341         void record_state_changed ();
342
343         /* Transport Control */
344
345         void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
346         void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
347
348         Gtkmm2ext::TearOff*      transport_tearoff;
349         Gtk::Frame               transport_frame;
350         Gtk::HBox                transport_tearoff_hbox;
351         Gtk::HBox                transport_hbox;
352         Gtk::Fixed               transport_base;
353         Gtk::Fixed               transport_button_base;
354         Gtk::Frame               transport_button_frame;
355         Gtk::HBox                transport_button_hbox;
356         Gtk::VBox                transport_button_vbox;
357         Gtk::HBox                transport_option_button_hbox;
358         Gtk::VBox                transport_option_button_vbox;
359         Gtk::HBox                transport_clock_hbox;
360         Gtk::VBox                transport_clock_vbox;
361         Gtk::HBox                primary_clock_hbox;
362         Gtk::HBox                secondary_clock_hbox;
363
364
365         struct TransportControllable : public PBD::Controllable {
366             enum ToggleType {
367                     Roll = 0,
368                     Stop,
369                     RecordEnable,
370                     GotoStart,
371                     GotoEnd,
372                     AutoLoop,
373                     PlaySelection,
374                     ShuttleControl
375                     
376             };
377             
378             TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
379             void set_value (float);
380             float get_value (void) const;
381             
382             void set_id (const std::string&);
383             
384             ARDOUR_UI& ui;
385             ToggleType type;
386         };
387
388         TransportControllable roll_controllable;
389         TransportControllable stop_controllable;
390         TransportControllable goto_start_controllable;
391         TransportControllable goto_end_controllable;
392         TransportControllable auto_loop_controllable;
393         TransportControllable play_selection_controllable;
394         TransportControllable rec_controllable;
395         TransportControllable shuttle_controllable;
396         BindingProxy shuttle_controller_binding_proxy;
397
398         void set_transport_controllable_state (const XMLNode&);
399         XMLNode& get_transport_controllable_state ();
400
401         BindableButton roll_button;
402         BindableButton stop_button;
403         BindableButton goto_start_button;
404         BindableButton goto_end_button;
405         BindableButton auto_loop_button;
406         BindableButton play_selection_button;
407         BindableButton rec_button;
408
409         Gtk::ComboBoxText sync_option_combo;
410
411         void sync_option_changed ();
412         void toggle_time_master ();
413         void toggle_video_sync ();
414
415         Gtk::DrawingArea  shuttle_box;
416         Gtk::EventBox     speed_display_box;
417         Gtk::Label        speed_display_label;
418         Gtk::Button       shuttle_units_button;
419         Gtk::ComboBoxText shuttle_style_button;
420         Gtk::Menu*        shuttle_unit_menu;
421         Gtk::Menu*        shuttle_style_menu;
422         float             shuttle_max_speed;
423         Gtk::Menu*        shuttle_context_menu;
424
425         void build_shuttle_context_menu ();
426         void show_shuttle_context_menu ();
427         void shuttle_style_changed();
428         void shuttle_unit_clicked ();
429         void set_shuttle_max_speed (float);
430         void update_speed_display ();
431         float last_speed_displayed;
432
433         gint shuttle_box_button_press (GdkEventButton*);
434         gint shuttle_box_button_release (GdkEventButton*);
435         gint shuttle_box_scroll (GdkEventScroll*);
436         gint shuttle_box_motion (GdkEventMotion*);
437         gint shuttle_box_expose (GdkEventExpose*);
438         gint mouse_shuttle (double x, bool force);
439         void use_shuttle_fract (bool force);
440         void set_shuttle_fract (double);
441
442         bool   shuttle_grabbed;
443         double shuttle_fract;
444
445         Gtkmm2ext::StatefulToggleButton punch_in_button;
446         Gtkmm2ext::StatefulToggleButton punch_out_button;
447         Gtkmm2ext::StatefulToggleButton auto_return_button;
448         Gtkmm2ext::StatefulToggleButton auto_play_button;
449         Gtkmm2ext::StatefulToggleButton auto_input_button;
450         Gtkmm2ext::StatefulToggleButton click_button;
451         Gtkmm2ext::StatefulToggleButton time_master_button;
452
453         Gtk::ToggleButton auditioning_alert_button;
454         Gtk::ToggleButton solo_alert_button;
455
456         Gtk::VBox alert_box;
457
458         void solo_blink (bool);
459         void audition_blink (bool);
460
461         void soloing_changed (bool);
462         void auditioning_changed (bool);
463         void _auditioning_changed (bool);
464
465         void solo_alert_toggle ();
466         void audition_alert_toggle ();
467
468         void primary_clock_value_changed ();
469         void secondary_clock_value_changed ();
470
471         /* called by Blink signal */
472
473         void transport_rec_enable_blink (bool onoff);
474
475         Gtk::Menu*        session_popup_menu;
476
477         struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
478             RecentSessionModelColumns() { 
479                     add (visible_name);
480                     add (fullpath);
481             }
482             Gtk::TreeModelColumn<Glib::ustring> visible_name;
483             Gtk::TreeModelColumn<Glib::ustring> fullpath;
484         };
485
486         RecentSessionModelColumns    recent_session_columns;
487         Gtk::TreeView                recent_session_display;
488         Glib::RefPtr<Gtk::TreeStore> recent_session_model;
489
490         ArdourDialog*     session_selector_window;
491         Gtk::FileChooserDialog* open_session_selector;
492         
493         void build_session_selector();
494         void redisplay_recent_sessions();
495         void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
496
497         struct RecentSessionsSorter {
498             bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
499                     return cmp_nocase(a.first, b.first) == -1;
500             }
501         };
502
503         /* menu bar and associated stuff */
504
505         Gtk::MenuBar* menu_bar;
506         Gtk::EventBox menu_bar_base;
507         Gtk::HBox     menu_hbox;
508
509         void build_menu_bar ();
510         void build_control_surface_menu ();
511
512         Gtk::Label   wall_clock_label;
513         Gtk::EventBox wall_clock_box;
514         gint update_wall_clock ();
515
516         Gtk::Label   disk_space_label;
517         Gtk::EventBox disk_space_box;
518         void update_disk_space ();
519
520         Gtk::Label   cpu_load_label;
521         Gtk::EventBox cpu_load_box;
522         void update_cpu_load ();
523
524         Gtk::Label   buffer_load_label;
525         Gtk::EventBox buffer_load_box;
526         void update_buffer_load ();
527
528         Gtk::Label   sample_rate_label;
529         Gtk::EventBox sample_rate_box;
530         void update_sample_rate (nframes_t);
531
532         gint every_second ();
533         gint every_point_one_seconds ();
534         gint every_point_zero_one_seconds ();
535
536         sigc::connection second_connection;
537         sigc::connection point_one_second_connection;
538         sigc::connection point_oh_five_second_connection;
539         sigc::connection point_zero_one_second_connection;
540
541         gint session_menu (GdkEventButton *);
542
543         bool _will_create_new_session_automatically;
544
545         NewSessionDialog* new_session_dialog;
546         
547         void open_session ();
548         void open_recent_session ();
549         void save_template ();
550
551         void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
552         void session_add_midi_route (bool disk, uint32_t how_many);
553
554         void set_transport_sensitivity (bool);
555
556         void remove_last_capture ();
557
558         void transport_goto_zero ();
559         void transport_goto_start ();
560         void transport_goto_end ();
561         void transport_stop ();
562         void transport_stop_and_forget_capture ();
563         void transport_record ();
564         void transport_roll ();
565         void transport_play_selection(); 
566         void transport_forward (int option);
567         void transport_rewind (int option);
568         void transport_loop ();
569
570         void transport_rolling ();
571         void transport_rewinding ();
572         void transport_forwarding ();
573         void transport_stopped ();
574
575         bool _session_is_new;
576         void connect_to_session (ARDOUR::Session *);
577         void connect_dependents_to_session (ARDOUR::Session *);
578         void we_have_dependents ();
579         
580         std::string keybindings_path;
581
582         void setup_keybindings ();
583         void setup_session_options ();
584         
585         guint32  last_key_press_time;
586
587         void snapshot_session ();
588
589         Mixer_UI   *mixer;
590         int         create_mixer ();
591         
592         PublicEditor     *editor;
593         int         create_editor ();
594
595         RouteParams_UI *route_params;
596         int             create_route_params ();
597
598         ConnectionEditor *connection_editor;
599         int               create_connection_editor ();
600
601         LocationUI *location_ui;
602         int         create_location_ui ();
603         void        handle_locations_change (ARDOUR::Location*);
604
605         ColorManager* color_manager;
606
607         /* Options window */
608         
609         OptionEditor *option_editor;
610         
611         /* route dialog */
612
613         AddRouteDialog *add_route_dialog;
614         
615         /* Keyboard Handling */
616         
617         Keyboard* keyboard;
618
619         /* Keymap handling */
620
621         void install_actions ();
622
623         void toggle_record_enable (uint32_t);
624
625         uint32_t rec_enabled_streams;
626         void count_recenabled_streams (ARDOUR::Route&);
627
628         About* about;
629         bool shown_flag;
630         /* cleanup */
631
632         Gtk::MenuItem *cleanup_item;
633
634         void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
635         void cleanup ();
636         void flush_trash ();
637
638         bool have_configure_timeout;
639         struct timeval last_configure_time;
640         gint configure_timeout ();
641
642         struct timeval last_peak_grab;
643         struct timeval last_shuttle_request;
644
645         bool have_disk_speed_dialog_displayed;
646         void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
647         void disk_overrun_handler ();
648         void disk_underrun_handler ();
649
650         int pending_state_dialog ();
651         
652         void disconnect_from_jack ();
653         void reconnect_to_jack ();
654         void set_jack_buffer_size (nframes_t);
655
656         Gtk::MenuItem* jack_disconnect_item;
657         Gtk::MenuItem* jack_reconnect_item;
658         Gtk::Menu*     jack_bufsize_menu;
659
660         int make_session_clean ();
661         bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
662
663         Glib::RefPtr<Gtk::ActionGroup> common_actions;
664
665         void editor_realized ();
666
667         std::vector<std::string> positional_sync_strings;
668
669         void toggle_send_midi_feedback ();
670         void toggle_use_mmc ();
671         void toggle_send_mmc ();
672         void toggle_send_mtc ();
673
674         void toggle_use_osc ();
675
676         void set_input_auto_connect (ARDOUR::AutoConnectOption);
677         void set_output_auto_connect (ARDOUR::AutoConnectOption);
678         void set_solo_model (ARDOUR::SoloModel);
679         void set_monitor_model (ARDOUR::MonitorModel);
680         void set_remote_model (ARDOUR::RemoteModel);
681
682         void toggle_StopPluginsWithTransport();
683         void toggle_DoNotRunPluginsWhileRecording();
684         void toggle_VerifyRemoveLastCapture();
685         void toggle_PeriodicSafetyBackups();
686         void toggle_StopRecordingOnXrun();
687         void toggle_StopTransportAtEndOfSession();
688         void toggle_GainReduceFastTransport();
689         void toggle_LatchedSolo();
690         void toggle_ShowSoloMutes();
691         void toggle_LatchedRecordEnable ();
692         void toggle_RegionEquivalentsOverlap ();
693         void toggle_PrimaryClockDeltaEditCursor ();
694         void toggle_SecondaryClockDeltaEditCursor ();
695
696         void mtc_port_changed ();
697         void map_solo_model ();
698         void map_monitor_model ();
699         void map_remote_model ();
700         void map_file_header_format ();
701         void map_file_data_format ();
702         void map_input_auto_connect ();
703         void map_output_auto_connect ();
704         void parameter_changed (const char*);
705
706         void set_meter_hold (ARDOUR::MeterHold);
707         void set_meter_falloff (ARDOUR::MeterFalloff);
708         void map_meter_hold ();
709         void map_meter_falloff ();
710
711         void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
712         void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
713
714         bool can_save_keybindings;
715         bool first_idle ();
716
717         void no_memory_warning ();
718         void check_memory_locking ();
719
720         bool ab_direction;
721         void disable_all_plugins ();
722         void ab_all_plugins ();
723 };
724
725 #endif /* __ardour_gui_h__ */
726