drastic, deep and wide changes to make RouteGroup use boost::shared_ptr<Route> and...
[ardour.git] / gtk2_ardour / public_editor.h
index 97618dcbc21ee89ceb44c4918cb529f3c3964735..e520e30a890bcfa1d412ccb00401c677ec25e3d3 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2007 Paul Davis 
+    Copyright (C) 2000-2007 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #include <string>
 #include <glib.h>
 #include <gdk/gdktypes.h>
+#include <gtkmm/box.h>
 #include <gtkmm/window.h>
 #include <gtkmm/actiongroup.h>
 #include <jack/types.h>
 #include <sigc++/signal.h>
 
-#include <pbd/statefuldestructible.h> 
+#include "evoral/types.hpp"
+#include "ardour/route_group.h"
+
+#include "pbd/statefuldestructible.h"
 
 #include "editing.h"
 #include "canvas.h"
@@ -38,7 +42,6 @@
 
 namespace ARDOUR {
        class Session;
-       class AudioExportSpecification;
        class Region;
        class Playlist;
        class RouteGroup;
@@ -85,11 +88,14 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
        PublicEditor ();
        virtual ~PublicEditor ();
 
-       typedef list<TimeAxisView *> TrackViewList;
+       typedef TrackSelection TrackViewList;
 
        /** @return Singleton PublicEditor instance */
        static PublicEditor& instance () { return *_instance; }
 
+       virtual bool have_idled() const = 0;
+       virtual void first_idle() = 0;
+
        /** Attach this editor to a Session.
         * @param s Session to connect to.
         */
@@ -103,6 +109,9 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
         */
        virtual void set_snap_to (Editing::SnapType t) = 0;
 
+       virtual Editing::SnapType snap_type () const = 0;
+       virtual Editing::SnapMode snap_mode () const = 0;
+
        /** Set the snap mode.
         * @param m Snap mode (defined in editing_syms.h)
         */
@@ -112,16 +121,14 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
         * @param t Snap threshold in `units'.
         */
        virtual void set_snap_threshold (double t) = 0;
-       
+
        /** Snap a value according to the current snap setting. */
-       virtual void snap_to (nframes_t& first, int32_t direction = 0, bool for_mark = false) = 0;
-       
-       /** Get the current snap value in beats */
-       virtual double snap_length_beats (nframes_t start) = 0;
+       virtual void snap_to (nframes64_t& first, int32_t direction = 0, bool for_mark = false) = 0;
 
        /** Undo some transactions.
         * @param n Number of transactions to undo.
         */
+
        virtual void undo (uint32_t n = 1) = 0;
 
        /** Redo some transactions.
@@ -146,6 +153,22 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
         */
        virtual Editing::MouseMode current_mouse_mode () const = 0;
 
+       /** Switch into a mode in which editing is primarily focused on "within" regions,
+           rather than regions as black-box objects. For Ardour3, this is aimed at
+           editing MIDI regions but may expand in the future to other types of regions.
+       */
+
+       virtual void set_internal_edit (bool yn) = 0;
+
+       /** @return Whether editing is currently in "internal" mode or not
+        */
+
+       virtual bool internal_editing() const = 0;
+
+       /** @return Sound edited notes in MIDI regions while editing
+        */
+       virtual bool sound_notes () const = 0;
+
        /** Possibly start the audition of a region.  If \ref r is 0, or not an AudioRegion
         * any current audition is cancelled.  If we are currently auditioning \ref r,
         * the audition will be cancelled.  Otherwise an audition of \ref r will start.
@@ -153,14 +176,6 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
         */
        virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
 
-       /** Set whether waveforms should be shown for audio tracks.
-        * @param yn true to show waveforms, otherwise false.
-        */
-       virtual void set_show_waveforms (bool yn) = 0;
-
-       /** @return true if waveforms are being shown, otherwise false */
-       virtual bool show_waveforms () const = 0;
-
        /** Set whether waveforms should be shown while recording audio tracks.
         * @param yn true to show waveforms, otherwise false.
         */
@@ -171,13 +186,16 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
        virtual void new_region_from_selection () = 0;
        virtual void separate_region_from_selection () = 0;
 
-       virtual void toggle_playback (bool with_abort) = 0;
        virtual void transition_to_rolling (bool fwd) = 0;
-       virtual nframes_t unit_to_frame (double unit) = 0;
-       virtual double frame_to_unit (nframes_t frame) = 0;
-       virtual double frame_to_unit (double frame) = 0;
-       virtual nframes_t pixel_to_frame (double pixel) = 0;
-       virtual gulong frame_to_pixel (nframes_t frame) = 0;
+       virtual nframes64_t unit_to_frame (double unit) const = 0;
+       // XXX remove me when libardour goes nframes64_t
+       double frame_to_unit (nframes_t frame) const {
+               return frame_to_unit ((nframes64_t) frame);
+       }
+       virtual double frame_to_unit (nframes64_t frame) const = 0;
+       virtual double frame_to_unit (double frame) const = 0;
+       virtual nframes64_t pixel_to_frame (double pixel) const = 0;
+       virtual gulong frame_to_pixel (nframes64_t frame) const = 0;
        virtual Selection& get_selection () const = 0;
        virtual Selection& get_cut_buffer () const = 0;
        virtual bool extend_selection_to_track (TimeAxisView&) = 0;
@@ -186,32 +204,29 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
        virtual bool show_measures () const = 0;
        virtual bool redraw_measures () = 0;
 
-       /** Open an export dialogue for the whole session */
-       virtual void export_session () = 0;
+       /** Open main export dialog */
+       virtual void export_audio () = 0;
 
-       /** Open an export dialogue for currently selected time range, if there
-        * is one; if not an error is displayed to the user.
-        */
+       /** Open export dialog with current selection pre-selected */
        virtual void export_selection () = 0;
 
-       /** Open an export dialogue for marked ranges */
-       virtual void export_range_markers () = 0;
+       /** Open export dialog with current range pre-selected */
+       virtual void export_range () = 0;
+
        virtual void register_actions () = 0;
        virtual void add_toplevel_controls (Gtk::Container&) = 0;
        virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
        virtual Editing::ZoomFocus get_zoom_focus () const = 0;
-       virtual gdouble get_current_zoom () = 0;
-       virtual PlaylistSelector& playlist_selector () const = 0;
-       virtual void route_name_changed (TimeAxisView *) = 0;
+       virtual gdouble   get_current_zoom () const = 0;
+       virtual PlaylistSelector& playlist_selector() const = 0;
        virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
-       virtual void new_playlists () = 0;
-       virtual void copy_playlists () = 0;
-       virtual void clear_playlists () = 0;
+       virtual void new_playlists (TimeAxisView*) = 0;
+       virtual void copy_playlists (TimeAxisView*) = 0;
+       virtual void clear_playlists (TimeAxisView*) = 0;
        virtual void select_all_tracks () = 0;
-       virtual bool set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
+       virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
        virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
-       virtual void hide_track_in_display (TimeAxisView& tv) = 0;
-       virtual void show_track_in_display (TimeAxisView& tv) = 0;
+       virtual void hide_track_in_display (TimeAxisView& tv, bool temporary = false) = 0;
 
        /** Set whether the editor should follow the playhead.
         * @param yn true to follow playhead, otherwise false.
@@ -226,35 +241,48 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
 
        /** @return true if the playhead is currently being dragged, otherwise false */
        virtual bool dragging_playhead () const = 0;
+       virtual double get_physical_screen_width() const = 0;
        virtual void ensure_float (Gtk::Window&) = 0;
        virtual void show_window () = 0;
        virtual TrackViewList* get_valid_views (TimeAxisView*, ARDOUR::RouteGroup* grp = 0) = 0;
-       virtual nframes_t leftmost_position () const = 0;
-       virtual nframes_t current_page_frames () const = 0;
+       virtual nframes64_t leftmost_position() const = 0;
+       virtual nframes64_t current_page_frames() const = 0;
        virtual void temporal_zoom_step (bool coarser) = 0;
        virtual void scroll_tracks_down_line () = 0;
        virtual void scroll_tracks_up_line () = 0;
        virtual bool new_regionviews_display_gain () = 0;
        virtual void prepare_for_cleanup () = 0;
-       virtual void reset_x_origin (nframes_t frame) = 0;
+       virtual void finish_cleanup () = 0;
+       virtual void reset_x_origin (nframes64_t frame) = 0;
        virtual void remove_last_capture () = 0;
        virtual void maximise_editing_space () = 0;
        virtual void restore_editing_space () = 0;
-       virtual nframes_t edit_cursor_position (bool sync) = 0;
+       virtual nframes64_t get_preferred_edit_position (bool ignore_playhead = false) = 0;
+       virtual void toggle_meter_updating() = 0;
+       virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret) = 0;
+       virtual void mouse_add_new_marker (nframes64_t where, bool is_cd=false, bool is_xrun=false) = 0;
+       virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
+       virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
+       virtual nframes64_t get_nudge_distance (nframes64_t pos, nframes64_t& next) = 0;
+       virtual Evoral::MusicalTime get_grid_type_as_beats (bool& success, nframes64_t position) = 0;
 
 #ifdef WITH_CMT
+       virtual void connect_to_image_compositor()  = 0;
        virtual void add_imageframe_time_axis(const std::string & track_name, void*)  = 0;
        virtual void add_imageframe_marker_time_axis(const std::string & track_name, TimeAxisView* marked_track, void*)  = 0;
-       virtual void connect_to_image_compositor()  = 0;
        virtual void scroll_timeaxis_to_imageframe_item(const TimeAxisViewItem* item)  = 0;
        virtual TimeAxisView* get_named_time_axis(const std::string & name)  = 0;
 #endif
 
+       virtual RouteTimeAxisView* get_route_view_by_id (PBD::ID& id) = 0;
+
+       virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, ARDOUR::RouteGroup::Property) const = 0;
+
        sigc::signal<void> ZoomFocusChanged;
        sigc::signal<void> ZoomChanged;
        sigc::signal<void> Resized;
        sigc::signal<void> Realized;
-       sigc::signal<void,nframes_t> UpdateAllTransportClocks;
+       sigc::signal<void,nframes64_t> UpdateAllTransportClocks;
 
        Glib::RefPtr<Gtk::ActionGroup> editor_actions;
 
@@ -271,6 +299,7 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
        virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
        virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
        virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
+       virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
        virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
        virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
        virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
@@ -285,6 +314,7 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
        virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
        virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
        virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
+       virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 
 #ifdef WITH_CMT
        virtual bool canvas_imageframe_item_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
@@ -297,10 +327,37 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
        virtual bool canvas_markerview_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
 #endif
 
+       static const int window_border_width;
+       static const int container_border_width;
+       static const int vertical_spacing;
+       static const int horizontal_spacing;
+
+#ifdef TOP_MENUBAR
+       /*
+        * This is needed for OS X primarily
+        * but also any other OS that uses a single
+        * top menubar instead of per window menus
+        */
+       virtual Gtk::HBox& get_status_bar_packer() = 0;
+#endif
+
+       virtual gdouble get_trackview_group_vertical_offset () const = 0;
+       virtual gdouble get_canvas_timebars_vsize () const = 0;
+       virtual ArdourCanvas::Group* get_background_group () const = 0;
+       virtual ArdourCanvas::Group* get_trackview_group () const = 0;
+
+       virtual TimeAxisView* axis_view_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
+
+       virtual void show_verbose_canvas_cursor_with (const std::string& txt) = 0;
+       virtual void hide_verbose_canvas_cursor() = 0;
+
+       virtual void center_screen (nframes64_t) = 0;
+
        /// Singleton instance, set up by Editor::Editor()
+
        static PublicEditor* _instance;
 
-       friend class PluginUIWindow;
+       friend bool relay_key_press (GdkEventKey*, Gtk::Window*);
 };
 
 #endif // __gtk_ardour_public_editor_h__