9dad6086be6f3bb5cd32f7af195b4a0582ab12d3
[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     $Id$
19 */
20
21 #ifndef __ardour_gui_h__
22 #define __ardour_gui_h__
23
24 /* need _BSD_SOURCE to get timersub macros */
25
26 #ifdef _BSD_SOURCE
27 #include <sys/time.h>
28 #else
29 #define _BSD_SOURCE
30 #include <sys/time.h>
31 #undef _BSD_SOURCE
32 #endif
33
34 #include <list>
35
36 #include <cmath>
37
38 #include <libgnomecanvasmm/canvas.h>
39
40 #include <pbd/xml++.h>
41 #include <gtkmm/box.h>
42 #include <gtkmm/frame.h>
43 #include <gtkmm/label.h>
44 #include <gtkmm/table.h>
45 #include <gtkmm/fixed.h>
46 #include <gtkmm/drawingarea.h>
47 #include <gtkmm/eventbox.h>
48 #include <gtkmm/menu.h>
49 #include <gtkmm/menuitem.h>
50 #include <gtkmm/button.h>
51 #include <gtkmm/togglebutton.h>
52 #include <gtkmm/treeview.h>
53 #include <gtkmm/menubar.h>
54 #include <gtkmm/adjustment.h>
55 #include <gtkmm2ext/gtk_ui.h>
56 #include <gtkmm2ext/click_box.h>
57 #include <gtkmm2ext/stateful_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 MeterBridge;
69 class OptionEditor;
70 class Mixer_UI;
71 class ConnectionEditor;
72 class RouteParams_UI;
73 class SoundFileBrowser;
74 class About;
75 class AddRouteDialog;
76 class NewSessionDialog;
77 class LocationUI;
78 class ColorManager;
79
80 namespace Gtkmm2ext {
81         class TearOff;
82 };
83
84 namespace ARDOUR {
85         class AudioEngine;
86         class Route;
87         class Port;
88         class IO;
89         class ControlProtocolInfo;
90 };
91
92 namespace ALSA {
93         class MultiChannelDevice;
94 };
95
96 #define FRAME_NAME "BaseFrame"
97
98 class ARDOUR_UI : public Gtkmm2ext::UI
99 {
100   public:
101         ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
102         ~ARDOUR_UI();
103
104         void show ();
105         bool shown() { return shown_flag; }
106         
107         void show_splash ();
108         void hide_splash ();
109         
110         int load_session (const string & path, const string & snapshot, string* mix_template = 0);
111         bool session_loaded;
112         int build_session (const string & path, const string & snapshot, 
113                            uint32_t ctl_chns, 
114                            uint32_t master_chns,
115                            ARDOUR::Session::AutoConnectOption input_connect,
116                            ARDOUR::Session::AutoConnectOption output_connect,
117                            uint32_t nphysin,
118                            uint32_t nphysout,
119                            jack_nframes_t initial_length);
120         bool session_is_new() const { return _session_is_new; }
121
122         ARDOUR::Session* the_session() { return session; }
123
124         bool will_create_new_session_automatically() const {
125                 return _will_create_new_session_automatically;
126         }
127
128         void set_will_create_new_session_automatically (bool yn) {
129                 _will_create_new_session_automatically = yn;
130         }
131
132         void new_session(bool startup = false, std::string path = string());
133         gint cmdline_new_session (string path);
134         int  unload_session ();
135         void close_session(); 
136
137         int  save_state_canfail (string state_name = "");
138         void save_state (const string & state_name = "");
139         void restore_state (string state_name = "");
140
141         static double gain_to_slider_position (ARDOUR::gain_t g);
142         static ARDOUR::gain_t slider_position_to_gain (double pos);
143
144         static ARDOUR_UI *instance () { return theArdourUI; }
145
146         PublicEditor&     the_editor(){return *editor;}
147         Mixer_UI* the_mixer() { return mixer; }
148         
149         void toggle_location_window ();
150         void toggle_color_manager ();
151         void toggle_big_clock_window ();
152         void toggle_connection_editor ();
153         void toggle_route_params_window ();
154         void toggle_tempo_window ();
155         void toggle_editing_space();
156
157         gint32 select_diskstream (GdkEventButton *ev);
158
159         Gtk::Tooltips& tooltips() { return _tooltips; }
160
161         static sigc::signal<void,bool> Blink;
162         static sigc::signal<void>      RapidScreenUpdate;
163         static sigc::signal<void>      SuperRapidScreenUpdate;
164         static sigc::signal<void,jack_nframes_t> Clock;
165
166         /* this is a helper function to centralize the (complex) logic for
167            blinking rec-enable buttons.
168         */
169
170         void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
171
172         void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
173         void choose_io (ARDOUR::IO&, bool input);
174
175         static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
176
177         XMLNode* editor_settings() const;
178         XMLNode* mixer_settings () const;
179         XMLNode* keyboard_settings () const;
180
181         void save_ardour_state ();
182         gboolean configure_handler (GdkEventConfigure* conf);
183
184         void do_transport_locate (jack_nframes_t position);
185         void halt_on_xrun_message ();
186
187         AudioClock primary_clock;
188         AudioClock secondary_clock;
189         AudioClock preroll_clock;
190         AudioClock postroll_clock;
191
192         void add_route ();
193         
194         void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode) {
195                 session_add_audio_route (true, input_channels, output_channels, mode);
196         }
197
198         void session_add_audio_bus (int input_channels, int32_t output_channels) {
199                 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal);
200         }
201
202         void session_add_midi_track () {
203                 session_add_midi_route (true);
204         }
205
206         void session_add_midi_bus () {
207                 session_add_midi_route (false);
208         }
209
210         void set_engine (ARDOUR::AudioEngine&);
211
212         gint exit_on_main_window_close (GdkEventAny *);
213
214         void maximise_editing_space ();
215         void restore_editing_space ();
216
217         void set_native_file_header_format (ARDOUR::HeaderFormat sf);
218         void set_native_file_data_format (ARDOUR::SampleFormat sf);
219
220   protected:
221         friend class PublicEditor;
222
223         void toggle_clocking ();
224         void toggle_auto_play ();
225         void toggle_auto_input ();
226         void toggle_punch_in ();
227         void toggle_punch_out ();
228         void toggle_auto_return ();
229         void toggle_click ();
230
231         void toggle_session_auto_loop ();
232         void toggle_session_punch_in ();
233         
234         void toggle_options_window ();
235
236   private:
237         struct GlobalClickBox : public Gtk::VBox {
238             Gtkmm2ext::ClickBox  *box;
239             Gtk::Frame      frame;
240             Gtk::Label      label;
241             vector<string> &strings;
242             Gtk::Adjustment adjustment;
243
244             static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
245
246             GlobalClickBox (const string &str, vector<string> &vs)
247                     : strings (vs),
248                       adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
249                     box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
250                     label.set_text (str);
251                     label.set_name ("GlobalButtonLabel");
252                     frame.add (*box);
253                     frame.set_shadow_type (Gtk::SHADOW_IN);
254                     pack_start (label);
255                     pack_start (frame);
256                     box->set_print_func (printer, this);
257                     box->set_wrap (true);
258             };
259         };
260
261         ARDOUR::AudioEngine                 *engine;
262         ARDOUR::Session                     *session;
263
264         Gtk::Tooltips          _tooltips;
265
266         void                     goto_editor_window ();
267         void                     goto_mixer_window ();
268         
269         Gtk::Table               adjuster_table;
270         Gtk::Frame               adjuster_frame;
271         Gtk::Fixed               adjuster_base;
272
273         GlobalClickBox     *online_control_button;
274         vector<string>      online_control_strings;
275
276         GlobalClickBox    *crossfade_time_button;
277         vector<string>     crossfade_time_strings;
278
279         GlobalClickBox    *mmc_id_button;
280         vector<string>     mmc_id_strings;
281
282         Gtk::ToggleButton   preroll_button;
283         Gtk::ToggleButton   postroll_button;
284
285         Gtk::Table          transport_table;
286         Gtk::Table          option_table;
287
288         int  setup_windows ();
289         void setup_session_menu ();
290         void setup_transport ();
291         void setup_clock ();
292         void setup_session_info ();
293         void setup_adjustables ();
294
295         Gtk::MenuBar* make_menubar ();
296         
297         static ARDOUR_UI *theArdourUI;
298
299         void startup ();
300         void shutdown ();
301
302         void finish();
303         int  ask_about_saving_session (const string & why);
304         gint ask_about_save_deleted (GdkEventAny*);
305         void save_session_choice_made (int);
306         int  save_the_session;
307
308         void queue_transport_change ();
309         void map_transport_state ();
310         int32_t do_engine_start ();
311         gint start_engine ();
312         
313         void engine_halted ();
314         void engine_stopped ();
315         void engine_running ();
316
317         void use_config ();
318
319         void clear_meters ();
320
321         static gint _blink  (void *);
322         void blink ();
323         gint blink_timeout_tag;
324         bool blink_on;
325         void start_blinking ();
326         void stop_blinking ();
327
328         void control_methods_adjusted ();
329         void mmc_device_id_adjusted ();
330
331   private:
332         Gtk::VBox     top_packer;
333
334         sigc::connection clock_signal_connection;
335         void         update_clocks ();
336         void         start_clocking ();
337         void         stop_clocking ();
338
339         void manage_window (Gtk::Window&);
340         
341         AudioClock   big_clock;
342         Gtk::Frame   big_clock_frame;
343         Gtk::Window* big_clock_window;
344
345         /* Transport Control */
346
347         void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
348         void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
349
350         Gtkmm2ext::TearOff*      transport_tearoff;
351         Gtk::Frame               transport_frame;
352         Gtk::HBox                transport_tearoff_hbox;
353         Gtk::HBox                transport_hbox;
354         Gtk::Fixed               transport_base;
355         Gtk::Fixed               transport_button_base;
356         Gtk::Frame               transport_button_frame;
357         Gtk::HBox                transport_button_hbox;
358         Gtk::VBox                transport_button_vbox;
359         Gtk::HBox                transport_option_button_hbox;
360         Gtk::VBox                transport_option_button_vbox;
361         Gtk::HBox                transport_clock_hbox;
362         Gtk::VBox                transport_clock_vbox;
363         Gtk::HBox                primary_clock_hbox;
364         Gtk::HBox                secondary_clock_hbox;
365
366         Gtkmm2ext::StatefulButton roll_button;
367         Gtkmm2ext::StatefulButton stop_button;
368         Gtkmm2ext::StatefulButton rewind_button;
369         Gtkmm2ext::StatefulButton forward_button;
370         Gtkmm2ext::StatefulButton goto_start_button;
371         Gtkmm2ext::StatefulButton goto_end_button;
372         Gtkmm2ext::StatefulButton auto_loop_button;
373         Gtkmm2ext::StatefulButton play_selection_button;
374
375         Gtkmm2ext::StatefulButton rec_button;
376
377         Gtk::ToggleButton time_master_button;
378         Gtk::ComboBoxText sync_option_combo;
379
380         void sync_option_changed ();
381         void toggle_time_master ();
382
383         enum ShuttleBehaviour {
384                 Sprung,
385                 Wheel
386         };
387
388         enum ShuttleUnits {
389                 Percentage,
390                 Semitones
391         };
392
393         Gtk::DrawingArea  shuttle_box;
394         Gtk::EventBox     speed_display_box;
395         Gtk::Label        speed_display_label;
396         Gtk::Button       shuttle_units_button;
397         Gtk::ComboBoxText shuttle_style_button;
398         Gtk::Menu*        shuttle_unit_menu;
399         Gtk::Menu*        shuttle_style_menu;
400         ShuttleBehaviour  shuttle_behaviour;
401         ShuttleUnits      shuttle_units;
402         float             shuttle_max_speed;
403         Gtk::Menu*        shuttle_context_menu;
404
405         void build_shuttle_context_menu ();
406         void show_shuttle_context_menu ();
407         void shuttle_style_changed();
408         void shuttle_unit_clicked ();
409         void set_shuttle_behaviour (ShuttleBehaviour);
410         void set_shuttle_units (ShuttleUnits);
411         void set_shuttle_max_speed (float);
412         void update_speed_display ();
413         float last_speed_displayed;
414
415         gint shuttle_box_button_press (GdkEventButton*);
416         gint shuttle_box_button_release (GdkEventButton*);
417         gint shuttle_box_scroll (GdkEventScroll*);
418         gint shuttle_box_motion (GdkEventMotion*);
419         gint shuttle_box_expose (GdkEventExpose*);
420         gint mouse_shuttle (double x, bool force);
421         void use_shuttle_fract (bool force);
422
423         bool   shuttle_grabbed;
424         double shuttle_fract;
425
426         Gtk::ToggleButton punch_in_button;
427         Gtk::ToggleButton punch_out_button;
428         Gtk::ToggleButton auto_return_button;
429         Gtk::ToggleButton auto_play_button;
430         Gtk::ToggleButton auto_input_button;
431         Gtk::ToggleButton click_button;
432         Gtk::ToggleButton auditioning_alert_button;
433         Gtk::ToggleButton solo_alert_button;
434
435         Gtk::VBox alert_box;
436         
437         void solo_blink (bool);
438         void audition_blink (bool);
439
440         void soloing_changed (bool);
441         void auditioning_changed (bool);
442         void _auditioning_changed (bool);
443
444         void solo_alert_toggle ();
445         void audition_alert_toggle ();
446
447         void primary_clock_value_changed ();
448         void secondary_clock_value_changed ();
449
450         /* called by Blink signal */
451
452         void transport_rec_enable_blink (bool onoff);
453
454         /* These change where we accept control from:
455            MMC, X (local) or both.
456         */
457
458         void allow_mmc_only ();
459         void allow_mmc_and_local ();
460         void allow_local_only ();
461
462         static void rate_printer (char buf[32], Gtk::Adjustment &, void *);
463
464         Gtk::Menu*        session_popup_menu;
465
466         struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
467             RecentSessionModelColumns() { 
468                     add (visible_name);
469                     add (fullpath);
470             }
471             Gtk::TreeModelColumn<Glib::ustring> visible_name;
472             Gtk::TreeModelColumn<Glib::ustring> fullpath;
473         };
474
475         RecentSessionModelColumns    recent_session_columns;
476         Gtk::TreeView                recent_session_display;
477         Glib::RefPtr<Gtk::TreeStore> recent_session_model;
478
479         ArdourDialog*     session_selector_window;
480         Gtk::FileChooserDialog* open_session_selector;
481         
482         void build_session_selector();
483         void recent_session_selection_changed ();
484         void redisplay_recent_sessions();
485         void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
486
487         struct RecentSessionsSorter {
488             bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
489                     return cmp_nocase(a.first, b.first) == -1;
490             }
491         };
492
493         /* menu bar and associated stuff */
494
495         Gtk::MenuBar* menu_bar;
496         Gtk::EventBox menu_bar_base;
497         Gtk::HBox     menu_hbox;
498
499         void build_menu_bar ();
500         void build_control_surface_menu ();
501         void pack_toplevel_controls();
502
503         Gtk::Label   wall_clock_label;
504         Gtk::EventBox wall_clock_box;
505         gint update_wall_clock ();
506
507         Gtk::Label   disk_space_label;
508         Gtk::EventBox disk_space_box;
509         void update_disk_space ();
510
511         Gtk::Label   cpu_load_label;
512         Gtk::EventBox cpu_load_box;
513         void update_cpu_load ();
514
515         Gtk::Label   buffer_load_label;
516         Gtk::EventBox buffer_load_box;
517         void update_buffer_load ();
518
519         Gtk::Label   sample_rate_label;
520         Gtk::EventBox sample_rate_box;
521         void update_sample_rate (jack_nframes_t);
522
523         gint every_second ();
524         gint every_point_one_seconds ();
525         gint every_point_zero_one_seconds ();
526
527         sigc::connection second_connection;
528         sigc::connection point_one_second_connection;
529         sigc::connection point_zero_one_second_connection;
530
531         void diskstream_added (ARDOUR::Diskstream*);
532
533         gint session_menu (GdkEventButton *);
534
535         bool _will_create_new_session_automatically;
536
537         NewSessionDialog* m_new_session_dialog;
538         
539         void open_session ();
540         void open_recent_session ();
541         void open_ok_clicked ();
542
543         void save_template ();
544
545
546         void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode);
547         void session_add_midi_route (bool disk);
548
549         void add_diskstream_to_menu (ARDOUR::AudioDiskstream&);
550         void diskstream_selected (gint32);
551         Gtk::Menu *diskstream_menu;
552         gint32 selected_dstream;
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_locating ();
571         void transport_rolling ();
572         void transport_rewinding ();
573         void transport_forwarding ();
574         void transport_stopped ();
575
576         void send_all_midi_feedback ();
577         
578         bool _session_is_new;
579         void connect_to_session (ARDOUR::Session *);
580         void connect_dependents_to_session (ARDOUR::Session *);
581         void we_have_dependents ();
582         void setup_keybindings ();
583         void setup_session_options ();
584         void setup_config_options ();
585         
586         guint32  last_key_press_time;
587
588         void snapshot_session ();
589
590         void map_record_state ();
591         void queue_map_record_state ();
592
593         Mixer_UI   *mixer;
594         int         create_mixer ();
595         
596         PublicEditor     *editor;
597         int         create_editor ();
598
599         RouteParams_UI *route_params;
600         int             create_route_params ();
601
602         ConnectionEditor *connection_editor;
603         int               create_connection_editor ();
604
605         LocationUI *location_ui;
606         int         create_location_ui ();
607         void        handle_locations_change (ARDOUR::Location*);
608
609         ColorManager* color_manager;
610
611         /* Options window */
612         
613         OptionEditor *option_editor;
614         
615         /* route dialog */
616
617         AddRouteDialog *add_route_dialog;
618         void add_route_dialog_done (int status);
619
620         /* SoundFile Browser */
621         SoundFileBrowser *sfdb;
622         void toggle_sound_file_browser ();
623         int create_sound_file_browser ();
624         
625         /* Keyboard Handling */
626         
627         Keyboard* keyboard;
628
629         /* Keymap handling */
630
631         Glib::RefPtr<Gtk::ActionGroup> get_common_actions();
632         void install_actions ();
633         void test_binding_action (const char *);
634         void start_keyboard_prefix();
635
636         void toggle_record_enable (guint32);
637         void toggle_monitor_enable (guint32);
638
639         uint32_t rec_enabled_diskstreams;
640         void count_recenabled_diskstreams (ARDOUR::AudioDiskstream&);
641
642         About* about;
643         bool shown_flag;
644         /* cleanup */
645
646         Gtk::MenuItem *cleanup_item;
647
648         void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
649         void cleanup ();
650         void flush_trash ();
651
652         bool have_configure_timeout;
653         struct timeval last_configure_time;
654         gint configure_timeout ();
655
656         struct timeval last_peak_grab;
657         struct timeval last_shuttle_request;
658
659         void delete_sources_in_the_right_thread (list<ARDOUR::AudioFileSource*>*);
660
661         void editor_display_control_changed (Editing::DisplayControl c);
662
663         bool have_disk_overrun_displayed;
664         bool have_disk_underrun_displayed;
665
666         void disk_overrun_message_gone ();
667         void disk_underrun_message_gone ();
668         void disk_overrun_handler ();
669         void disk_underrun_handler ();
670
671         int pending_state_dialog ();
672         
673         void disconnect_from_jack ();
674         void reconnect_to_jack ();
675         void set_jack_buffer_size (jack_nframes_t);
676
677         Gtk::MenuItem* jack_disconnect_item;
678         Gtk::MenuItem* jack_reconnect_item;
679         Gtk::Menu*     jack_bufsize_menu;
680
681         int make_session_clean ();
682         bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
683
684         Glib::RefPtr<Gtk::ActionGroup> common_actions;
685
686         void editor_realized ();
687
688         std::vector<std::string> positional_sync_strings;
689
690         void toggle_config_state (const char* group, const char* action, void (ARDOUR::Configuration::*set)(bool));
691         void toggle_session_state (const char* group, const char* action, void (ARDOUR::Session::*set)(bool), bool (ARDOUR::Session::*get)(void) const);
692         void toggle_session_state (const char* group, const char* action, sigc::slot<void> theSlot);
693         void toggle_send_midi_feedback ();
694         void toggle_use_mmc ();
695         void toggle_send_mmc ();
696         void toggle_use_midi_control();
697         void toggle_send_mtc ();
698
699         void toggle_AutoConnectNewTrackInputsToHardware();
700         void toggle_AutoConnectNewTrackOutputsToHardware();
701         void toggle_AutoConnectNewTrackOutputsToMaster();
702         void toggle_ManuallyConnectNewTrackOutputs();
703         void toggle_UseHardwareMonitoring();
704         void toggle_UseSoftwareMonitoring();
705         void toggle_UseExternalMonitoring();
706         void toggle_StopPluginsWithTransport();
707         void toggle_DoNotRunPluginsWhileRecording();
708         void toggle_VerifyRemoveLastCapture();
709         void toggle_StopRecordingOnXrun();
710         void toggle_StopTransportAtEndOfSession();
711         void toggle_GainReduceFastTransport();
712         void toggle_LatchedSolo();
713         void toggle_SoloViaBus();
714         void toggle_AutomaticallyCreateCrossfades();
715         void toggle_UnmuteNewFullCrossfades();
716         void toggle_LatchedRecordEnable ();
717
718         void mtc_port_changed ();
719         void map_some_session_state (const char* group, const char* action, bool (ARDOUR::Session::*get)() const);
720         void queue_session_control_changed (ARDOUR::Session::ControlType t);
721         void session_control_changed (ARDOUR::Session::ControlType t);
722
723         void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
724 };
725
726
727 #endif /* __ardour_gui_h__ */