Add a couple of missing ellipses to menu items.
[ardour.git] / gtk2_ardour / ardour_ui.h
index 47be382f46cebece48f5349944efc77104bc8a57..08e0d42ab089dec16bca6350c5e6dce12079fba7 100644 (file)
 #include "ardour/utils.h"
 #include "ardour/session_handle.h"
 
-#include "audio_clock.h"
 #include "ardour_dialog.h"
 #include "editing.h"
 #include "ui_config.h"
+#include "window_proxy.h"
 
 class About;
 class AddRouteDialog;
@@ -82,8 +82,15 @@ class PublicEditor;
 class RCOptionEditor;
 class RouteParams_UI;
 class SessionOptionEditor;
+class ShuttleControl;
 class Splash;
+class SpeakerDialog;
 class ThemeManager;
+class TimeInfoBox;
+class MidiTracer;
+class WindowProxyBase;
+class GlobalPortMatrixWindow;
+class GUIObjectState;
 
 namespace Gtkmm2ext {
        class TearOff;
@@ -98,39 +105,29 @@ namespace ARDOUR {
        class Location;
 }
 
-extern sigc::signal<void>  ColorsChanged;
-extern sigc::signal<void>  DPIReset;
-
 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
 {
   public:
        ARDOUR_UI (int *argcp, char **argvp[]);
        ~ARDOUR_UI();
 
-       bool run_startup (bool should_be_new);
-
-       void show ();
-       bool shown() { return shown_flag; }
+       bool run_startup (bool should_be_new, std::string load_template);
 
        void show_splash ();
        void hide_splash ();
 
-        void launch_chat ();
+       void launch_chat ();
+       void launch_manual ();
+       void launch_reference ();
        void show_about ();
        void hide_about ();
 
-       void idle_load (const Glib::ustring& path);
+       void idle_load (const std::string& path);
        void finish();
 
-       int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
+       int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
        bool session_loaded;
-       int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
-                          uint32_t master_chns,
-                          ARDOUR::AutoConnectOption input_connect,
-                          ARDOUR::AutoConnectOption output_connect,
-                          uint32_t nphysin,
-                          uint32_t nphysout,
-                          nframes_t initial_length);
+       int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
        bool session_is_new() const { return _session_is_new; }
 
        ARDOUR::Session* the_session() { return _session; }
@@ -143,21 +140,16 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
                _will_create_new_session_automatically = yn;
        }
 
-       int get_session_parameters (bool quit_on_cancel, bool should_be_new = false);
-       void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
-       int  load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
-       int  build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
-       bool ask_about_loading_existing_session (const Glib::ustring& session_path);
+       int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
+       int  build_session_from_nsd (const std::string& session_name, const std::string& session_path);
+       bool ask_about_loading_existing_session (const std::string& session_path);
 
        /// @return true if session was successfully unloaded.
        int unload_session (bool hide_stuff = false);
        void close_session();
 
-       int  save_state_canfail (std::string state_name = "");
-       void save_state (const std::string & state_name = "");
-
-       static double gain_to_slider_position (ARDOUR::gain_t g);
-       static ARDOUR::gain_t slider_position_to_gain (double pos);
+       int  save_state_canfail (std::string state_name = "", bool switch_to_it = false);
+       void save_state (const std::string & state_name = "", bool switch_to_it = false);
 
        static ARDOUR_UI *instance () { return theArdourUI; }
        static UIConfiguration *config () { return ui_config; }
@@ -170,50 +162,85 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        void toggle_theme_manager ();
        void toggle_bundle_manager ();
        void toggle_big_clock_window ();
+       void toggle_speaker_config_window ();
+       void new_midi_tracer_window ();
        void toggle_route_params_window ();
        void toggle_editing_space();
+       void toggle_keep_tearoffs();
 
        Gtk::Tooltips& tooltips() { return _tooltips; }
 
+       Gtk::HBox& editor_transport_box() { return _editor_transport_box; }
+
+       static PublicEditor* _instance;
        static sigc::signal<void,bool> Blink;
        static sigc::signal<void>      RapidScreenUpdate;
        static sigc::signal<void>      SuperRapidScreenUpdate;
-       static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
+       /** Emitted frequently with the audible frame, false, and the edit point as
+        *  parameters respectively.
+        */
+       static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
 
        XMLNode* editor_settings() const;
        XMLNode* mixer_settings () const;
        XMLNode* keyboard_settings () const;
-        XMLNode* tearoff_settings (const char*) const;
+       XMLNode* tearoff_settings (const char*) const;
 
        void save_ardour_state ();
        gboolean configure_handler (GdkEventConfigure* conf);
 
-       void do_transport_locate (nframes_t position);
+       void do_transport_locate (framepos_t, bool);
        void halt_on_xrun_message ();
-       void xrun_handler (nframes_t);
-       void create_xrun_marker (nframes_t);
+       void xrun_handler (framepos_t);
+       void create_xrun_marker (framepos_t);
+
+       GUIObjectState* gui_object_state;
 
-       AudioClock primary_clock;
-       AudioClock secondary_clock;
-       AudioClock preroll_clock;
-       AudioClock postroll_clock;
+       AudioClock* primary_clock;
+       AudioClock* secondary_clock;
+       AudioClock* preroll_clock;
+       AudioClock* postroll_clock;
+
+       TimeInfoBox* time_info_box;
 
        void store_clock_modes ();
        void restore_clock_modes ();
        void reset_main_clocks ();
 
+       void synchronize_sync_source_and_video_pullup ();
+
        void add_route (Gtk::Window* float_window);
 
-       void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, ARDOUR::RouteGroup* route_group, uint32_t how_many) {
-               session_add_audio_route (true, false, input_channels, output_channels, mode, route_group, how_many);
+       void session_add_audio_track (
+               int input_channels,
+               int32_t output_channels,
+               ARDOUR::TrackMode mode,
+               ARDOUR::RouteGroup* route_group,
+               uint32_t how_many,
+               std::string const & name_template
+               ) {
+
+               session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
        }
 
-       void session_add_audio_bus (bool aux,  int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group, uint32_t how_many) {
-               session_add_audio_route (false, aux, input_channels, output_channels, ARDOUR::Normal, route_group, how_many);
+       void session_add_audio_bus (
+               int input_channels,
+               int32_t output_channels,
+               ARDOUR::RouteGroup* route_group,
+               uint32_t how_many,
+               std::string const & name_template
+               ) {
+
+               session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
        }
 
-       void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many) {
-               session_add_midi_route (true, route_group, how_many);
+       void session_add_midi_track (
+               ARDOUR::RouteGroup* route_group,
+               uint32_t how_many,
+               std::string const & name_template
+               ) {
+
+               session_add_midi_route (true, route_group, how_many, name_template);
        }
 
        /*void session_add_midi_bus () {
@@ -234,6 +261,9 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
 
        void set_shuttle_fract (double);
 
+       void add_window_proxy (WindowProxyBase *);
+       void remove_window_proxy (WindowProxyBase *);
+
   protected:
        friend class PublicEditor;
 
@@ -262,8 +292,8 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
 
        void                goto_editor_window ();
        void                goto_mixer_window ();
-       void                toggle_editor_mixer_on_top ();
-       bool                _mixer_on_top;
+       void                toggle_mixer_window ();
+       void                toggle_mixer_on_top ();
 
        Gtk::ToggleButton   preroll_button;
        Gtk::ToggleButton   postroll_button;
@@ -278,7 +308,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        void startup ();
        void shutdown ();
 
-       int  ask_about_saving_session (const std::string & why);
+       int  ask_about_saving_session (const std::vector<std::string>& actions);
 
        /* periodic safety backup, to be precise */
        gint autosave_session();
@@ -288,7 +318,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        void map_transport_state ();
        int32_t do_engine_start ();
 
-       void engine_halted ();
+       void engine_halted (const char* reason, bool free_reason);
        void engine_stopped ();
        void engine_running ();
 
@@ -303,7 +333,6 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
 
        void about_signal_response(int response);
 
-  private:
        Gtk::VBox     top_packer;
 
        sigc::connection clock_signal_connection;
@@ -313,11 +342,11 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
 
        void manage_window (Gtk::Window&);
 
-       AudioClock   big_clock;
-       Gtk::Window* big_clock_window;
-        int original_big_clock_width;
-        int original_big_clock_height;
-        double original_big_clock_font_size;
+       AudioClock*   big_clock;
+       ActionWindowProxy<Gtk::Window>* big_clock_window;
+       int original_big_clock_width;
+       int original_big_clock_height;
+       double original_big_clock_font_size;
 
        void big_clock_size_allocate (Gtk::Allocation&);
        bool idle_big_clock_text_resizer (int width, int height);
@@ -328,9 +357,13 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        void float_big_clock (Gtk::Window* parent);
        bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
 
-       void update_transport_clocks (nframes_t pos);
+       ActionWindowProxy<SpeakerDialog>* speaker_config_window;
+
+       void update_transport_clocks (framepos_t pos);
        void record_state_changed ();
 
+       std::list<MidiTracer*> _midi_tracer_windows;
+
        /* Transport Control */
 
        void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
@@ -339,8 +372,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        Gtkmm2ext::TearOff*      transport_tearoff;
        Gtk::Frame               transport_frame;
        Gtk::HBox                transport_tearoff_hbox;
-       Gtk::HBox                play_range_hbox;
-       Gtk::VBox                play_range_vbox;
+       Gtk::HBox               _editor_transport_box;
        Gtk::HBox                transport_hbox;
        Gtk::Fixed               transport_base;
        Gtk::Fixed               transport_button_base;
@@ -354,7 +386,6 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        Gtk::HBox                primary_clock_hbox;
        Gtk::HBox                secondary_clock_hbox;
 
-
        struct TransportControllable : public PBD::Controllable {
            enum ToggleType {
                    Roll = 0,
@@ -364,13 +395,11 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
                    GotoEnd,
                    AutoLoop,
                    PlaySelection,
-                   ShuttleControl
-
            };
 
            TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
-           void set_value (float);
-           float get_value (void) const;
+           void set_value (double);
+           double get_value (void) const;
 
            void set_id (const std::string&);
 
@@ -386,7 +415,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        boost::shared_ptr<TransportControllable> play_selection_controllable;
        boost::shared_ptr<TransportControllable> rec_controllable;
        boost::shared_ptr<TransportControllable> shuttle_controllable;
-       BindingProxy shuttle_controller_binding_proxy;
+       boost::shared_ptr<TransportControllable> join_play_range_controllable;
 
        void set_transport_controllable_state (const XMLNode&);
        XMLNode& get_transport_controllable_state ();
@@ -398,43 +427,14 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        BindableButton auto_loop_button;
        BindableButton play_selection_button;
        BindableButton rec_button;
-       Gtk::ToggleButton join_play_range_button;
+       BindableToggleButton join_play_range_button;
 
        void toggle_external_sync ();
        void toggle_time_master ();
        void toggle_video_sync ();
 
-       Gtk::DrawingArea  shuttle_box;
-       Gtk::EventBox     speed_display_box;
-       Gtk::Label        speed_display_label;
-       Gtk::Button       shuttle_units_button;
-       Gtk::ComboBoxText shuttle_style_button;
-       Gtk::Menu*        shuttle_unit_menu;
-       Gtk::Menu*        shuttle_style_menu;
-       float             shuttle_max_speed;
-       Gtk::Menu*        shuttle_context_menu;
-
-       void build_shuttle_context_menu ();
-       void show_shuttle_context_menu ();
-       void shuttle_style_changed();
-       void shuttle_unit_clicked ();
-       void set_shuttle_max_speed (float);
-       void update_speed_display ();
-       float last_speed_displayed;
-
-       gint shuttle_box_button_press (GdkEventButton*);
-       gint shuttle_box_button_release (GdkEventButton*);
-       gint shuttle_box_scroll (GdkEventScroll*);
-       gint shuttle_box_motion (GdkEventMotion*);
-       gint shuttle_box_expose (GdkEventExpose*);
-       gint mouse_shuttle (double x, bool force);
-       void use_shuttle_fract (bool force);
-
-       bool   shuttle_grabbed;
-       double shuttle_fract;
-
-       Gtkmm2ext::StatefulToggleButton punch_in_button;
-       Gtkmm2ext::StatefulToggleButton punch_out_button;
+       ShuttleControl* shuttle_box;
+
        Gtkmm2ext::StatefulToggleButton auto_return_button;
        Gtkmm2ext::StatefulToggleButton auto_play_button;
        Gtkmm2ext::StatefulToggleButton auto_input_button;
@@ -473,8 +473,8 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
                    add (visible_name);
                    add (fullpath);
            }
-           Gtk::TreeModelColumn<Glib::ustring> visible_name;
-           Gtk::TreeModelColumn<Glib::ustring> fullpath;
+           Gtk::TreeModelColumn<std::string> visible_name;
+           Gtk::TreeModelColumn<std::string> fullpath;
        };
 
        RecentSessionModelColumns    recent_session_columns;
@@ -521,8 +521,12 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
 
        Gtk::Label   sample_rate_label;
        Gtk::EventBox sample_rate_box;
-       void update_sample_rate (nframes_t);
+       void update_sample_rate (ARDOUR::framecnt_t);
 
+       Gtk::Label    format_label;
+       Gtk::EventBox format_box;
+       void update_format ();
+       
        gint every_second ();
        gint every_point_one_seconds ();
        gint every_point_zero_one_seconds ();
@@ -543,8 +547,8 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        void edit_metadata ();
        void import_metadata ();
 
-       void session_add_audio_route (bool disk, bool aux, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, ARDOUR::RouteGroup *, uint32_t how_many);
-       void session_add_midi_route (bool disk, ARDOUR::RouteGroup *, uint32_t how_many);
+       void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
+       void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &);
 
        void set_transport_sensitivity (bool);
 
@@ -573,7 +577,8 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
 
        guint32  last_key_press_time;
 
-       void snapshot_session ();
+       void snapshot_session (bool switch_to_it);
+       void rename_session ();
 
        Mixer_UI   *mixer;
        int         create_mixer ();
@@ -587,10 +592,13 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        BundleManager *bundle_manager;
        void create_bundle_manager ();
 
-       LocationUIWindow *location_ui;
+       ActionWindowProxy<LocationUIWindow>* location_ui;
        int               create_location_ui ();
        void              handle_locations_change (ARDOUR::Location*);
 
+       ActionWindowProxy<GlobalPortMatrixWindow>* _global_port_matrix[ARDOUR::DataType::num_types];
+       void toggle_global_port_matrix (ARDOUR::DataType);
+
        static UIConfiguration *ui_config;
        ThemeManager *theme_manager;
 
@@ -611,7 +619,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        /* Keyboard Handling */
 
        ArdourKeyboard* keyboard;
-       
+
        /* Keymap handling */
 
        void install_actions ();
@@ -624,7 +632,6 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        About* about;
        Splash* splash;
        void pop_back_splash ();
-       bool shown_flag;
 
        /* cleanup */
 
@@ -642,19 +649,6 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        ARDOUR::microseconds_t last_peak_grab;
        ARDOUR::microseconds_t last_shuttle_request;
 
-       struct DiskBufferStat {
-           time_t when;
-           uint32_t capture;
-           uint32_t playback;
-
-           DiskBufferStat (time_t w, uint32_t c, uint32_t p)
-           : when (w), capture (c), playback (p) {}
-       };
-
-       std::list<DiskBufferStat> disk_buffer_stats;
-       void push_buffer_stats (uint32_t, uint32_t);
-       void write_buffer_stats ();
-
        bool have_disk_speed_dialog_displayed;
        void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
        void disk_overrun_handler ();
@@ -662,11 +656,11 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
 
        void session_dialog (std::string);
        int pending_state_dialog ();
-       int sr_mismatch_dialog (nframes_t, nframes_t);
+       int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
 
        void disconnect_from_jack ();
        void reconnect_to_jack ();
-       void set_jack_buffer_size (nframes_t);
+       void set_jack_buffer_size (ARDOUR::pframes_t);
 
        Gtk::MenuItem* jack_disconnect_item;
        Gtk::MenuItem* jack_reconnect_item;
@@ -687,6 +681,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
        void toggle_use_osc ();
 
        void parameter_changed (std::string);
+       void session_parameter_changed (std::string);
 
        bool first_idle ();
 
@@ -700,16 +695,33 @@ class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
                        Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
                        const char *msg);
        Gtk::Label status_bar_label;
+        bool status_bar_button_press (GdkEventButton*);
        Gtk::ToggleButton error_log_button;
 
        void loading_message (const std::string& msg);
        void end_loading_messages ();
 
+        void toggle_translations ();
+
+       PBD::ScopedConnectionList forever_connections;
+
+        void step_edit_status_change (bool);
+
        void platform_specific ();
        void platform_setup ();
+
+       /* these are used only in response to a platform-specific "ShouldQuit" signal
+        */
+       bool idle_finish ();
+       void queue_finish ();
        void fontconfig_dialog ();
 
-       PBD::ScopedConnectionList forever_connections;
+       std::list<WindowProxyBase*> _window_proxies;
+
+        int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
+        int ambiguous_file (std::string file, std::string path, std::vector<std::string> hits);
+
+       bool click_button_clicked (GdkEventButton *);
 };
 
 #endif /* __ardour_gui_h__ */