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