5a9b7c4ae4d046fcf444a1ce4718023baa5d7f81
[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         Gtk::Tooltips& tooltips() { return _tooltips; }
158
159         static sigc::signal<void,bool> Blink;
160         static sigc::signal<void>      RapidScreenUpdate;
161         static sigc::signal<void>      SuperRapidScreenUpdate;
162         static sigc::signal<void,jack_nframes_t> Clock;
163
164         /* this is a helper function to centralize the (complex) logic for
165            blinking rec-enable buttons.
166         */
167
168         void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
169
170         void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
171         void choose_io (ARDOUR::IO&, bool input);
172
173         static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
174
175         XMLNode* editor_settings() const;
176         XMLNode* mixer_settings () const;
177         XMLNode* keyboard_settings () const;
178
179         void save_ardour_state ();
180         gboolean configure_handler (GdkEventConfigure* conf);
181
182         void do_transport_locate (jack_nframes_t position);
183         void halt_on_xrun_message ();
184
185         AudioClock primary_clock;
186         AudioClock secondary_clock;
187         AudioClock preroll_clock;
188         AudioClock postroll_clock;
189
190         void add_route ();
191         
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);
194         }
195
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);
198         }
199
200         void session_add_midi_track ();
201
202         void set_engine (ARDOUR::AudioEngine&);
203
204         gint exit_on_main_window_close (GdkEventAny *);
205
206         void maximise_editing_space ();
207         void restore_editing_space ();
208
209         void set_native_file_header_format (ARDOUR::HeaderFormat sf);
210         void set_native_file_data_format (ARDOUR::SampleFormat sf);
211
212   protected:
213         friend class PublicEditor;
214
215         void toggle_clocking ();
216         void toggle_auto_play ();
217         void toggle_auto_input ();
218         void toggle_punch_in ();
219         void toggle_punch_out ();
220         void toggle_auto_return ();
221         void toggle_click ();
222
223         void toggle_session_auto_loop ();
224         void toggle_session_punch_in ();
225         
226         void toggle_options_window ();
227
228   private:
229         struct GlobalClickBox : public Gtk::VBox {
230             Gtkmm2ext::ClickBox  *box;
231             Gtk::Frame      frame;
232             Gtk::Label      label;
233             vector<string> &strings;
234             Gtk::Adjustment adjustment;
235
236             static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
237
238             GlobalClickBox (const string &str, vector<string> &vs)
239                     : strings (vs),
240                       adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
241                     box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
242                     label.set_text (str);
243                     label.set_name ("GlobalButtonLabel");
244                     frame.add (*box);
245                     frame.set_shadow_type (Gtk::SHADOW_IN);
246                     pack_start (label);
247                     pack_start (frame);
248                     box->set_print_func (printer, this);
249                     box->set_wrap (true);
250             };
251         };
252
253         ARDOUR::AudioEngine                 *engine;
254         ARDOUR::Session                     *session;
255
256         Gtk::Tooltips          _tooltips;
257
258         void                     goto_editor_window ();
259         void                     goto_mixer_window ();
260         
261         Gtk::Table               adjuster_table;
262         Gtk::Frame               adjuster_frame;
263         Gtk::Fixed               adjuster_base;
264
265         GlobalClickBox     *online_control_button;
266         vector<string>      online_control_strings;
267
268         GlobalClickBox    *crossfade_time_button;
269         vector<string>     crossfade_time_strings;
270
271         GlobalClickBox    *mmc_id_button;
272         vector<string>     mmc_id_strings;
273
274         Gtk::ToggleButton   preroll_button;
275         Gtk::ToggleButton   postroll_button;
276
277         Gtk::Table          transport_table;
278         Gtk::Table          option_table;
279
280         int  setup_windows ();
281         void setup_session_menu ();
282         void setup_transport ();
283         void setup_clock ();
284         void setup_session_info ();
285         void setup_adjustables ();
286
287         Gtk::MenuBar* make_menubar ();
288         
289         static ARDOUR_UI *theArdourUI;
290
291         void startup ();
292         void shutdown ();
293
294         void finish();
295         int  ask_about_saving_session (const string & why);
296         gint ask_about_save_deleted (GdkEventAny*);
297         void save_session_choice_made (int);
298         int  save_the_session;
299
300         void queue_transport_change ();
301         void map_transport_state ();
302         int32_t do_engine_start ();
303         gint start_engine ();
304         
305         void engine_halted ();
306         void engine_stopped ();
307         void engine_running ();
308
309         void use_config ();
310
311         void clear_meters ();
312
313         static gint _blink  (void *);
314         void blink ();
315         gint blink_timeout_tag;
316         bool blink_on;
317         void start_blinking ();
318         void stop_blinking ();
319
320         void control_methods_adjusted ();
321         void mmc_device_id_adjusted ();
322
323   private:
324         Gtk::VBox     top_packer;
325
326         sigc::connection clock_signal_connection;
327         void         update_clocks ();
328         void         start_clocking ();
329         void         stop_clocking ();
330
331         void manage_window (Gtk::Window&);
332         
333         AudioClock   big_clock;
334         Gtk::Frame   big_clock_frame;
335         Gtk::Window* big_clock_window;
336
337         /* Transport Control */
338
339         void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
340         void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
341
342         Gtkmm2ext::TearOff*      transport_tearoff;
343         Gtk::Frame               transport_frame;
344         Gtk::HBox                transport_tearoff_hbox;
345         Gtk::HBox                transport_hbox;
346         Gtk::Fixed               transport_base;
347         Gtk::Fixed               transport_button_base;
348         Gtk::Frame               transport_button_frame;
349         Gtk::HBox                transport_button_hbox;
350         Gtk::VBox                transport_button_vbox;
351         Gtk::HBox                transport_option_button_hbox;
352         Gtk::VBox                transport_option_button_vbox;
353         Gtk::HBox                transport_clock_hbox;
354         Gtk::VBox                transport_clock_vbox;
355         Gtk::HBox                primary_clock_hbox;
356         Gtk::HBox                secondary_clock_hbox;
357
358         Gtkmm2ext::StatefulButton roll_button;
359         Gtkmm2ext::StatefulButton stop_button;
360         Gtkmm2ext::StatefulButton rewind_button;
361         Gtkmm2ext::StatefulButton forward_button;
362         Gtkmm2ext::StatefulButton goto_start_button;
363         Gtkmm2ext::StatefulButton goto_end_button;
364         Gtkmm2ext::StatefulButton auto_loop_button;
365         Gtkmm2ext::StatefulButton play_selection_button;
366
367         Gtkmm2ext::StatefulButton rec_button;
368
369         Gtk::ToggleButton time_master_button;
370         Gtk::ComboBoxText sync_option_combo;
371
372         void sync_option_changed ();
373         void toggle_time_master ();
374
375         enum ShuttleBehaviour {
376                 Sprung,
377                 Wheel
378         };
379
380         enum ShuttleUnits {
381                 Percentage,
382                 Semitones
383         };
384
385         Gtk::DrawingArea  shuttle_box;
386         Gtk::EventBox     speed_display_box;
387         Gtk::Label        speed_display_label;
388         Gtk::Button       shuttle_units_button;
389         Gtk::ComboBoxText shuttle_style_button;
390         Gtk::Menu*        shuttle_unit_menu;
391         Gtk::Menu*        shuttle_style_menu;
392         ShuttleBehaviour  shuttle_behaviour;
393         ShuttleUnits      shuttle_units;
394         float             shuttle_max_speed;
395         Gtk::Menu*        shuttle_context_menu;
396
397         void build_shuttle_context_menu ();
398         void show_shuttle_context_menu ();
399         void shuttle_style_changed();
400         void shuttle_unit_clicked ();
401         void set_shuttle_behaviour (ShuttleBehaviour);
402         void set_shuttle_units (ShuttleUnits);
403         void set_shuttle_max_speed (float);
404         void update_speed_display ();
405         float last_speed_displayed;
406
407         gint shuttle_box_button_press (GdkEventButton*);
408         gint shuttle_box_button_release (GdkEventButton*);
409         gint shuttle_box_scroll (GdkEventScroll*);
410         gint shuttle_box_motion (GdkEventMotion*);
411         gint shuttle_box_expose (GdkEventExpose*);
412         gint mouse_shuttle (double x, bool force);
413         void use_shuttle_fract (bool force);
414
415         bool   shuttle_grabbed;
416         double shuttle_fract;
417
418         Gtk::ToggleButton punch_in_button;
419         Gtk::ToggleButton punch_out_button;
420         Gtk::ToggleButton auto_return_button;
421         Gtk::ToggleButton auto_play_button;
422         Gtk::ToggleButton auto_input_button;
423         Gtk::ToggleButton click_button;
424         Gtk::ToggleButton auditioning_alert_button;
425         Gtk::ToggleButton solo_alert_button;
426
427         Gtk::VBox alert_box;
428         
429         void solo_blink (bool);
430         void audition_blink (bool);
431
432         void soloing_changed (bool);
433         void auditioning_changed (bool);
434         void _auditioning_changed (bool);
435
436         void solo_alert_toggle ();
437         void audition_alert_toggle ();
438
439         void primary_clock_value_changed ();
440         void secondary_clock_value_changed ();
441
442         /* called by Blink signal */
443
444         void transport_rec_enable_blink (bool onoff);
445
446         /* These change where we accept control from:
447            MMC, X (local) or both.
448         */
449
450         void allow_mmc_only ();
451         void allow_mmc_and_local ();
452         void allow_local_only ();
453
454         static void rate_printer (char buf[32], Gtk::Adjustment &, void *);
455
456         Gtk::Menu*        session_popup_menu;
457
458         struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
459             RecentSessionModelColumns() { 
460                     add (visible_name);
461                     add (fullpath);
462             }
463             Gtk::TreeModelColumn<Glib::ustring> visible_name;
464             Gtk::TreeModelColumn<Glib::ustring> fullpath;
465         };
466
467         RecentSessionModelColumns    recent_session_columns;
468         Gtk::TreeView                recent_session_display;
469         Glib::RefPtr<Gtk::TreeStore> recent_session_model;
470
471         ArdourDialog*     session_selector_window;
472         Gtk::FileChooserDialog* open_session_selector;
473         
474         void build_session_selector();
475         void recent_session_selection_changed ();
476         void redisplay_recent_sessions();
477         void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
478
479         struct RecentSessionsSorter {
480             bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
481                     return cmp_nocase(a.first, b.first) == -1;
482             }
483         };
484
485         /* menu bar and associated stuff */
486
487         Gtk::MenuBar* menu_bar;
488         Gtk::EventBox menu_bar_base;
489         Gtk::HBox     menu_hbox;
490
491         void build_menu_bar ();
492         void build_control_surface_menu ();
493         void pack_toplevel_controls();
494
495         Gtk::Label   wall_clock_label;
496         Gtk::EventBox wall_clock_box;
497         gint update_wall_clock ();
498
499         Gtk::Label   disk_space_label;
500         Gtk::EventBox disk_space_box;
501         void update_disk_space ();
502
503         Gtk::Label   cpu_load_label;
504         Gtk::EventBox cpu_load_box;
505         void update_cpu_load ();
506
507         Gtk::Label   buffer_load_label;
508         Gtk::EventBox buffer_load_box;
509         void update_buffer_load ();
510
511         Gtk::Label   sample_rate_label;
512         Gtk::EventBox sample_rate_box;
513         void update_sample_rate (jack_nframes_t);
514
515         gint every_second ();
516         gint every_point_one_seconds ();
517         gint every_point_zero_one_seconds ();
518
519         sigc::connection second_connection;
520         sigc::connection point_one_second_connection;
521         sigc::connection point_zero_one_second_connection;
522
523         gint session_menu (GdkEventButton *);
524
525         bool _will_create_new_session_automatically;
526
527         NewSessionDialog* m_new_session_dialog;
528         
529         void open_session ();
530         void open_recent_session ();
531         void open_ok_clicked ();
532
533         void save_template ();
534
535         void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
536
537         void set_transport_sensitivity (bool);
538
539         void remove_last_capture ();
540
541         void transport_goto_zero ();
542         void transport_goto_start ();
543         void transport_goto_end ();
544         void transport_stop ();
545         void transport_stop_and_forget_capture ();
546         void transport_record ();
547         void transport_roll ();
548         void transport_play_selection(); 
549         void transport_forward (int option);
550         void transport_rewind (int option);
551         void transport_loop ();
552
553         void transport_locating ();
554         void transport_rolling ();
555         void transport_rewinding ();
556         void transport_forwarding ();
557         void transport_stopped ();
558
559         void send_all_midi_feedback ();
560         
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 ();
565         void setup_keybindings ();
566         void setup_session_options ();
567         void setup_config_options ();
568         
569         guint32  last_key_press_time;
570
571         void snapshot_session ();
572
573         void map_record_state ();
574         void queue_map_record_state ();
575
576         Mixer_UI   *mixer;
577         int         create_mixer ();
578         
579         PublicEditor     *editor;
580         int         create_editor ();
581
582         RouteParams_UI *route_params;
583         int             create_route_params ();
584
585         ConnectionEditor *connection_editor;
586         int               create_connection_editor ();
587
588         LocationUI *location_ui;
589         int         create_location_ui ();
590         void        handle_locations_change (ARDOUR::Location*);
591
592         ColorManager* color_manager;
593
594         /* Options window */
595         
596         OptionEditor *option_editor;
597         
598         /* route dialog */
599
600         AddRouteDialog *add_route_dialog;
601         void add_route_dialog_done (int status);
602
603         /* SoundFile Browser */
604         SoundFileBrowser *sfdb;
605         void toggle_sound_file_browser ();
606         int create_sound_file_browser ();
607         
608         /* Keyboard Handling */
609         
610         Keyboard* keyboard;
611
612         /* Keymap handling */
613
614         Glib::RefPtr<Gtk::ActionGroup> get_common_actions();
615         void install_actions ();
616         void test_binding_action (const char *);
617         void start_keyboard_prefix();
618
619         void toggle_record_enable (uint32_t);
620
621         uint32_t rec_enabled_diskstreams;
622         void count_recenabled_diskstreams (ARDOUR::Route&);
623
624         About* about;
625         bool shown_flag;
626         /* cleanup */
627
628         Gtk::MenuItem *cleanup_item;
629
630         void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
631         void cleanup ();
632         void flush_trash ();
633
634         bool have_configure_timeout;
635         struct timeval last_configure_time;
636         gint configure_timeout ();
637
638         struct timeval last_peak_grab;
639         struct timeval last_shuttle_request;
640
641         void delete_sources_in_the_right_thread (list<boost::shared_ptr<ARDOUR::Source> >*);
642
643         void editor_display_control_changed (Editing::DisplayControl c);
644
645         bool have_disk_overrun_displayed;
646         bool have_disk_underrun_displayed;
647
648         void disk_overrun_message_gone ();
649         void disk_underrun_message_gone ();
650         void disk_overrun_handler ();
651         void disk_underrun_handler ();
652
653         int pending_state_dialog ();
654         
655         void disconnect_from_jack ();
656         void reconnect_to_jack ();
657         void set_jack_buffer_size (jack_nframes_t);
658
659         Gtk::MenuItem* jack_disconnect_item;
660         Gtk::MenuItem* jack_reconnect_item;
661         Gtk::Menu*     jack_bufsize_menu;
662
663         int make_session_clean ();
664         bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
665
666         Glib::RefPtr<Gtk::ActionGroup> common_actions;
667
668         void editor_realized ();
669
670         std::vector<std::string> positional_sync_strings;
671
672         void toggle_config_state (const char* group, const char* action, void (ARDOUR::Configuration::*set)(bool));
673         void toggle_session_state (const char* group, const char* action, void (ARDOUR::Session::*set)(bool), bool (ARDOUR::Session::*get)(void) const);
674         void toggle_session_state (const char* group, const char* action, sigc::slot<void> theSlot);
675         void toggle_send_midi_feedback ();
676         void toggle_use_mmc ();
677         void toggle_send_mmc ();
678         void toggle_use_midi_control();
679         void toggle_send_mtc ();
680
681         void toggle_AutoConnectNewTrackInputsToHardware();
682         void toggle_AutoConnectNewTrackOutputsToHardware();
683         void toggle_AutoConnectNewTrackOutputsToMaster();
684         void toggle_ManuallyConnectNewTrackOutputs();
685         void toggle_UseHardwareMonitoring();
686         void toggle_UseSoftwareMonitoring();
687         void toggle_UseExternalMonitoring();
688         void toggle_StopPluginsWithTransport();
689         void toggle_DoNotRunPluginsWhileRecording();
690         void toggle_VerifyRemoveLastCapture();
691         void toggle_StopRecordingOnXrun();
692         void toggle_StopTransportAtEndOfSession();
693         void toggle_GainReduceFastTransport();
694         void toggle_LatchedSolo();
695         void toggle_SoloViaBus();
696         void toggle_AutomaticallyCreateCrossfades();
697         void toggle_UnmuteNewFullCrossfades();
698         void toggle_LatchedRecordEnable ();
699
700         void mtc_port_changed ();
701         void map_some_session_state (const char* group, const char* action, bool (ARDOUR::Session::*get)() const);
702         void queue_session_control_changed (ARDOUR::Session::ControlType t);
703         void session_control_changed (ARDOUR::Session::ControlType t);
704
705         void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
706 };
707
708 #endif /* __ardour_gui_h__ */
709