gtk2_ardour/public_editor.h

   1 /*
   2  * Copyright (C) 2005-2018 Paul Davis <paul@linuxaudiosystems.com>
   3  * Copyright (C) 2005 Karsten Wiese <fzuuzf@googlemail.com>
   4  * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
   5  * Copyright (C) 2006-2015 David Robillard <d@drobilla.net>
   6  * Copyright (C) 2007-2012 Carl Hetherington <carl@carlh.net>
   7  * Copyright (C) 2007-2016 Tim Mayberry <mojofunk@gmail.com>
   8  * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
   9  * Copyright (C) 2014-2017 Nick Mainsbridge <mainsbridge@gmail.com>
  10  * Copyright (C) 2014-2018 Ben Loftis <ben@harrisonconsoles.com>
  11  * Copyright (C) 2015 Colin Fletcher <colin.m.fletcher@googlemail.com>
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  26  */
  27
  28 #ifndef __gtk_ardour_public_editor_h__
  29 #define __gtk_ardour_public_editor_h__
  30
  31 #ifdef WAF_BUILD
  32 #include "gtk2ardour-config.h"
  33 #endif
  34
  35 #include <map>
  36
  37 #include <string>
  38 #include <glib.h>
  39 #include <gdk/gdktypes.h>
  40 #include <gtkmm/box.h>
  41 #include <gtkmm/window.h>
  42 #include <gtkmm/actiongroup.h>
  43 #include <gtkmm/notebook.h>
  44 #include <sigc++/signal.h>
  45
  46 #include "pbd/statefuldestructible.h"
  47
  48 #include "temporal/beats.h"
  49
  50 #include "evoral/Note.h"
  51
  52 #include "ardour/session_handle.h"
  53
  54 #include "canvas/fwd.h"
  55
  56 #include "gtkmm2ext/actions.h"
  57 #include "gtkmm2ext/bindings.h"
  58 #include "gtkmm2ext/visibility_tracker.h"
  59
  60 #include "widgets/tabbable.h"
  61
  62 #include "axis_provider.h"
  63 #include "editing.h"
  64 #include "selection.h"
  65
  66 namespace ARDOUR {
  67         class Session;
  68         class Region;
  69         class Playlist;
  70         class RouteGroup;
  71         class Trimmable;
  72         class Movable;
  73         class Stripable;
  74 }
  75
  76 namespace Gtk {
  77         class Container;
  78         class Menu;
  79 }
  80
  81 class AudioRegionView;
  82 class AutomationLine;
  83 class AutomationTimeAxisView;
  84 class ControlPoint;
  85 class DragManager;
  86 class Editor;
  87 class ArdourMarker;
  88 class MeterMarker;
  89 class MixerStrip;
  90 class MouseCursors;
  91 class PlaylistSelector;
  92 class PluginSelector;
  93 class PluginUIWindow;
  94 class RegionView;
  95 class RouteTimeAxisView;
  96 class Selection;
  97 class StripableTimeAxisView;
  98 class TempoCurve;
  99 class TempoMarker;
 100 class TimeAxisView;
 101 class TimeAxisViewItem;
 102 class VerboseCursor;
 103 class XMLNode;
 104 struct SelectionRect;
 105
 106 class DisplaySuspender;
 107
 108 namespace ARDOUR_UI_UTILS {
 109 bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
 110 bool forward_key_press (GdkEventKey* ev);
 111 }
 112
 113 using ARDOUR::samplepos_t;
 114 using ARDOUR::samplecnt_t;
 115
 116 /// Representation of the interface of the Editor class
 117
 118 /** This class contains just the public interface of the Editor class,
 119  * in order to decouple it from the private implementation, so that callers
 120  * of PublicEditor need not be recompiled if private methods or member variables
 121  * change.
 122  */
 123 class PublicEditor : public ArdourWidgets::Tabbable,  public ARDOUR::SessionHandlePtr, public AxisViewProvider
 124 {
 125 public:
 126         PublicEditor (Gtk::Widget& content);
 127         virtual ~PublicEditor ();
 128
 129         /** @return Singleton PublicEditor instance */
 130         static PublicEditor& instance () { return *_instance; }
 131
 132         virtual bool have_idled() const = 0;
 133         virtual void first_idle() = 0;
 134
 135         virtual void setup_tooltips() = 0;
 136
 137         /** Attach this editor to a Session.
 138          * @param s Session to connect to.
 139          */
 140         virtual void set_session (ARDOUR::Session* s) = 0;
 141
 142         /** Set the snap type.
 143          * @param t Snap type (defined in editing_syms.h)
 144          */
 145         virtual void set_grid_to (Editing::GridType t) = 0;
 146
 147         virtual Editing::GridType grid_type () const = 0;
 148         virtual Editing::SnapMode snap_mode () const = 0;
 149
 150         /** Set the snap mode.
 151          * @param m Snap mode (defined in editing_syms.h)
 152          */
 153         virtual void set_snap_mode (Editing::SnapMode m) = 0;
 154
 155         /**
 156          * Snap a value according to the current snap setting.
 157          * ensure_snap overrides SnapOff and magnetic snap
 158          */
 159         virtual void snap_to (ARDOUR::MusicSample& first,
 160                               ARDOUR::RoundMode   direction = ARDOUR::RoundNearest,
 161                               ARDOUR::SnapPref    gpref = ARDOUR::SnapToAny_Visual,
 162                               bool                ensure_snap = false) = 0;
 163
 164         /** Undo some transactions.
 165          * @param n Number of transactions to undo.
 166          */
 167
 168         virtual void undo (uint32_t n = 1) = 0;
 169
 170         /** Redo some transactions.
 171          * @param n Number of transaction to redo.
 172          */
 173         virtual void redo (uint32_t n = 1) = 0;
 174
 175         /** Set the mouse mode (gain, object, range, timefx etc.)
 176          * @param m Mouse mode (defined in editing_syms.h)
 177          * @param force Perform the effects of the change even if no change is required
 178          * (ie even if the current mouse mode is equal to @param m)
 179          */
 180         virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
 181
 182         /** Step the mouse mode onto the next or previous one.
 183          * @param next true to move to the next, otherwise move to the previous
 184          */
 185         virtual void step_mouse_mode (bool next) = 0;
 186
 187         /** @return The current mouse mode (gain, object, range, timefx etc.)
 188          * (defined in editing_syms.h)
 189          */
 190         virtual Editing::MouseMode current_mouse_mode () const = 0;
 191
 192         /** @return Whether the current mouse mode is an "internal" editing mode. */
 193         virtual bool internal_editing() const = 0;
 194
 195         /** Possibly start the audition of a region.
 196          *
 197          * If \p r is 0, or not an AudioRegion any current audition is cancelled.
 198          * If we are currently auditioning \p r , the audition will be cancelled.
 199          * Otherwise an audition of \p r will start.
 200          *
 201          * @param r Region to consider auditioning
 202          */
 203         virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
 204
 205         /* import dialogs -> ardour-ui ?! */
 206         virtual void external_audio_dialog () = 0;
 207         virtual void session_import_dialog () = 0;
 208
 209         virtual void new_region_from_selection () = 0;
 210         virtual void separate_region_from_selection () = 0;
 211
 212         virtual void transition_to_rolling (bool fwd) = 0;
 213         virtual samplepos_t pixel_to_sample (double pixel) const = 0;
 214         virtual samplepos_t playhead_cursor_sample () const = 0;
 215         virtual double sample_to_pixel (samplepos_t sample) const = 0;
 216         virtual double sample_to_pixel_unrounded (samplepos_t sample) const = 0;
 217
 218         virtual Selection& get_selection () const = 0;
 219         virtual bool get_selection_extents (samplepos_t &start, samplepos_t &end) const = 0;
 220         virtual Selection& get_cut_buffer () const = 0;
 221
 222         virtual void set_selection (std::list<Selectable*>, Selection::Operation) = 0;
 223
 224         virtual bool extend_selection_to_track (TimeAxisView&) = 0;
 225         virtual void play_solo_selection(bool restart) = 0;
 226         virtual void play_selection () = 0;
 227         virtual void play_with_preroll () = 0;
 228         virtual void rec_with_preroll () = 0;
 229         virtual void rec_with_count_in () = 0;
 230         virtual void maybe_locate_with_edit_preroll (samplepos_t location) = 0;
 231         virtual void goto_nth_marker (int nth) = 0;
 232         virtual void trigger_script (int nth) = 0;
 233         virtual void add_location_from_playhead_cursor () = 0;
 234         virtual void remove_location_at_playhead_cursor () = 0;
 235         virtual void update_grid () = 0;
 236         virtual void remove_tracks () = 0;
 237         virtual void set_loop_range (samplepos_t start, samplepos_t end, std::string cmd) = 0;
 238         virtual void set_punch_range (samplepos_t start, samplepos_t end, std::string cmd) = 0;
 239
 240         virtual void jump_forward_to_mark () = 0;
 241         virtual void jump_backward_to_mark () = 0;
 242
 243         virtual void set_session_start_from_playhead () = 0;
 244         virtual void set_session_end_from_playhead () = 0;
 245
 246         virtual void toggle_location_at_playhead_cursor () = 0;
 247
 248         virtual void nudge_forward (bool next, bool force_playhead) = 0;
 249         virtual void nudge_backward (bool next, bool force_playhead) = 0;
 250
 251         virtual void playhead_forward_to_grid () = 0;
 252         virtual void playhead_backward_to_grid () = 0;
 253
 254         virtual void keyboard_selection_begin ( Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE) = 0;
 255         virtual void keyboard_selection_finish (bool add, Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE) = 0;
 256
 257         virtual void set_punch_start_from_edit_point () = 0;
 258         virtual void set_punch_end_from_edit_point () = 0;
 259         virtual void set_loop_start_from_edit_point () = 0;
 260         virtual void set_loop_end_from_edit_point () = 0;
 261
 262         virtual Editing::MouseMode effective_mouse_mode () const = 0;
 263
 264         /** Import existing media */
 265         virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality,
 266                                 ARDOUR::MidiTrackNameSource, ARDOUR::MidiTempoMapDisposition, samplepos_t&,
 267                                 boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
 268         virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,
 269                                samplepos_t&,
 270                                boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
 271
 272         /** Open main export dialog */
 273         virtual void export_audio () = 0;
 274
 275         /** Open stem export dialog */
 276         virtual void stem_export () = 0;
 277
 278         /** Open export dialog with current selection pre-selected */
 279         virtual void export_selection () = 0;
 280
 281         /** Open export dialog with current range pre-selected */
 282         virtual void export_range () = 0;
 283
 284         virtual void register_actions () = 0;
 285         virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
 286         virtual Editing::ZoomFocus get_zoom_focus () const = 0;
 287         virtual samplecnt_t get_current_zoom () const = 0;
 288         virtual void reset_zoom (samplecnt_t) = 0;
 289         virtual PlaylistSelector& playlist_selector() const = 0;
 290         virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
 291         virtual void new_playlists (TimeAxisView*) = 0;
 292         virtual void copy_playlists (TimeAxisView*) = 0;
 293         virtual void clear_playlists (TimeAxisView*) = 0;
 294         virtual void select_all_tracks () = 0;
 295         virtual void deselect_all () = 0;
 296         virtual void invert_selection () = 0;
 297         virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
 298         virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
 299         virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
 300         virtual void show_track_in_display (TimeAxisView* tv, bool move_into_view = false) = 0;
 301
 302         virtual void set_stationary_playhead (bool yn) = 0;
 303         virtual void toggle_stationary_playhead () = 0;
 304         virtual bool stationary_playhead() const = 0;
 305
 306         /** Set whether the editor should follow the playhead.
 307          * @param yn true to follow playhead, otherwise false.
 308          * @param catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
 309          */
 310         virtual void set_follow_playhead (bool yn, bool catch_up = true) = 0;
 311
 312         /** Toggle whether the editor is following the playhead */
 313         virtual void toggle_follow_playhead () = 0;
 314
 315         /** @return true if the editor is following the playhead */
 316         virtual bool follow_playhead () const = 0;
 317
 318         /** @return true if the playhead is currently being dragged, otherwise false */
 319         virtual bool dragging_playhead () const = 0;
 320         virtual samplepos_t leftmost_sample() const = 0;
 321         virtual samplecnt_t current_page_samples() const = 0;
 322         virtual double visible_canvas_height () const = 0;
 323         virtual void temporal_zoom_step (bool coarser) = 0;
 324         virtual void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top = false) = 0;
 325         virtual void override_visible_track_count () = 0;
 326         virtual void scroll_tracks_down_line () = 0;
 327         virtual void scroll_tracks_up_line () = 0;
 328         virtual bool scroll_down_one_track (bool skip_child_views = false) = 0;
 329         virtual bool scroll_up_one_track (bool skip_child_views = false) = 0;
 330         virtual void select_topmost_track () = 0;
 331         virtual void cleanup_regions () = 0;
 332         virtual void prepare_for_cleanup () = 0;
 333         virtual void finish_cleanup () = 0;
 334         virtual void reset_x_origin (samplepos_t sample) = 0;
 335         virtual double get_y_origin () const = 0;
 336         virtual void reset_y_origin (double pos) = 0;
 337         virtual void set_visible_track_count (int32_t) = 0;
 338         virtual void fit_selection () = 0;
 339         virtual void remove_last_capture () = 0;
 340         virtual void maximise_editing_space () = 0;
 341         virtual void restore_editing_space () = 0;
 342         virtual samplepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE, bool from_context_menu = false, bool from_outside_canvas = false) = 0;
 343         virtual void toggle_meter_updating() = 0;
 344         virtual void split_regions_at (ARDOUR::MusicSample, RegionSelection&) = 0;
 345         virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
 346         virtual void mouse_add_new_marker (samplepos_t where, bool is_cd=false) = 0;
 347         virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
 348         virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
 349         virtual samplecnt_t get_nudge_distance (samplepos_t pos, samplecnt_t& next) = 0;
 350         virtual samplecnt_t get_paste_offset (samplepos_t pos, unsigned paste_count, samplecnt_t duration) = 0;
 351         virtual unsigned get_grid_beat_divisions(samplepos_t position) = 0;
 352         virtual Temporal::Beats get_grid_type_as_beats (bool& success, samplepos_t position) = 0;
 353         virtual int32_t get_grid_music_divisions (uint32_t event_state) = 0;
 354         virtual void edit_notes (MidiRegionView*) = 0;
 355
 356         virtual void queue_visual_videotimeline_update () = 0;
 357         virtual void set_close_video_sensitive (bool) = 0;
 358         virtual void toggle_ruler_video (bool) = 0;
 359         virtual void toggle_xjadeo_proc (int) = 0;
 360         virtual void toggle_xjadeo_viewoption (int, int) = 0;
 361         virtual void set_xjadeo_sensitive (bool onoff) = 0;
 362         virtual int  get_videotl_bar_height () const = 0;
 363         virtual void set_video_timeline_height (const int h) = 0;
 364         virtual void embed_audio_from_video (std::string, samplepos_t n = 0, bool lock_position_to_video = true) = 0;
 365
 366         virtual bool track_selection_change_without_scroll () const = 0;
 367
 368         virtual StripableTimeAxisView* get_stripable_time_axis_by_id (const PBD::ID& id) const = 0;
 369
 370         virtual TimeAxisView* time_axis_view_from_stripable (boost::shared_ptr<ARDOUR::Stripable> s) const = 0;
 371
 372         virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, PBD::PropertyID) const = 0;
 373         virtual RegionView* regionview_from_region (boost::shared_ptr<ARDOUR::Region>) const = 0;
 374         virtual RouteTimeAxisView* rtav_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
 375
 376         sigc::signal<void> ZoomChanged;
 377         sigc::signal<void> Realized;
 378         sigc::signal<void,samplepos_t> UpdateAllTransportClocks;
 379
 380         static sigc::signal<void> DropDownKeys;
 381
 382         struct RegionAction {
 383                 Glib::RefPtr<Gtk::Action> action;
 384                 Editing::RegionActionTarget target;
 385
 386                 RegionAction (Glib::RefPtr<Gtk::Action> a, Editing::RegionActionTarget tgt)
 387                         : action (a), target (tgt) {}
 388         };
 389
 390         std::map<std::string,RegionAction> region_action_map;
 391
 392         Glib::RefPtr<Gtk::ActionGroup> editor_actions;
 393         Glib::RefPtr<Gtk::ActionGroup> editor_menu_actions;
 394         Glib::RefPtr<Gtk::ActionGroup> _region_actions;
 395
 396         virtual bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas) = 0;
 397         virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
 398         virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
 399         virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 400         virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 401         virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 402         virtual bool canvas_start_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 403         virtual bool canvas_end_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 404         virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 405         virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
 406         virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 407         virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
 408         virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 409         virtual bool canvas_wave_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 410         virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 411         virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 412         virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 413         virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 414         virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
 415         virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, ArdourMarker*) = 0;
 416         virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 417         virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
 418         virtual bool canvas_tempo_curve_event (GdkEvent* event, ArdourCanvas::Item*, TempoCurve*) = 0;
 419         virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
 420         virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
 421
 422         virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 423         virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 424         virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 425         virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 426         virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 427         virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 428
 429         static const int window_border_width;
 430         static const int container_border_width;
 431         static const int vertical_spacing;
 432         static const int horizontal_spacing;
 433
 434         virtual ArdourCanvas::Container* get_trackview_group () const = 0;
 435         virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
 436         virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
 437         virtual ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const = 0;
 438         virtual ArdourCanvas::Container* get_drag_motion_group () const = 0;
 439
 440         virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
 441
 442         virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
 443         virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
 444
 445         virtual void center_screen (samplepos_t) = 0;
 446
 447         virtual TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const = 0;
 448         virtual TrackViewList const & get_track_views () const = 0;
 449
 450         virtual MixerStrip* get_current_mixer_strip () const = 0;
 451
 452         virtual DragManager* drags () const = 0;
 453         virtual bool drag_active () const = 0;
 454         virtual bool preview_video_drag_active () const = 0;
 455         virtual void maybe_autoscroll (bool, bool, bool from_headers) = 0;
 456         virtual void stop_canvas_autoscroll () = 0;
 457         virtual bool autoscroll_active() const = 0;
 458
 459         virtual void begin_reversible_selection_op (std::string cmd_name) = 0;
 460         virtual void commit_reversible_selection_op () = 0;
 461         virtual void begin_reversible_command (std::string cmd_name) = 0;
 462         virtual void begin_reversible_command (GQuark) = 0;
 463         virtual void abort_reversible_command () = 0;
 464         virtual void commit_reversible_command () = 0;
 465
 466         virtual void access_action (const std::string&, const std::string&) = 0;
 467         virtual void set_toggleaction (const std::string&, const std::string&, bool) = 0;
 468
 469         virtual MouseCursors const* cursors () const = 0;
 470         virtual VerboseCursor* verbose_cursor () const = 0;
 471
 472         virtual bool get_smart_mode () const = 0;
 473
 474         virtual void get_pointer_position (double &, double &) const = 0;
 475
 476         virtual ARDOUR::Location* find_location_from_marker (ArdourMarker*, bool&) const = 0;
 477         virtual ArdourMarker* find_marker_from_location_id (PBD::ID const&, bool) const = 0;
 478
 479         virtual void snap_to_with_modifier (ARDOUR::MusicSample& first,
 480                                             GdkEvent const*      ev,
 481                                             ARDOUR::RoundMode    direction = ARDOUR::RoundNearest,
 482                                             ARDOUR::SnapPref     gpref = ARDOUR::SnapToAny_Visual) = 0;
 483
 484         virtual void set_snapped_cursor_position (samplepos_t pos) = 0;
 485
 486         virtual void get_regions_at (RegionSelection &, samplepos_t where, TrackViewList const &) const = 0;
 487         virtual void get_regions_after (RegionSelection&, samplepos_t where, const TrackViewList& ts) const = 0;
 488         virtual RegionSelection get_regions_from_selection_and_mouse (samplepos_t) = 0;
 489         virtual void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const = 0;
 490         virtual void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Temporal::Beats> > > > >&) const = 0;
 491
 492         virtual void build_region_boundary_cache () = 0;
 493         virtual void mark_region_boundary_cache_dirty () = 0;
 494
 495         virtual void mouse_add_new_tempo_event (samplepos_t where) = 0;
 496         virtual void mouse_add_new_meter_event (samplepos_t where) = 0;
 497         virtual void edit_tempo_section (ARDOUR::TempoSection*) = 0;
 498         virtual void edit_meter_section (ARDOUR::MeterSection*) = 0;
 499
 500         /// Singleton instance, set up by Editor::Editor()
 501
 502         static PublicEditor* _instance;
 503
 504         friend bool ARDOUR_UI_UTILS::relay_key_press (GdkEventKey*, Gtk::Window*);
 505         friend bool ARDOUR_UI_UTILS::forward_key_press (GdkEventKey*);
 506
 507         PBD::Signal0<void> SnapChanged;
 508         PBD::Signal0<void> MouseModeChanged;
 509
 510         Gtkmm2ext::Bindings* bindings;
 511
 512 protected:
 513         friend class DisplaySuspender;
 514         virtual void suspend_route_redisplay () = 0;
 515         virtual void resume_route_redisplay () = 0;
 516         gint _suspend_route_redisplay_counter;
 517 };
 518
 519 class DisplaySuspender {
 520         public:
 521                 DisplaySuspender() {
 522                         if (g_atomic_int_add(&PublicEditor::instance()._suspend_route_redisplay_counter, 1) == 0) {
 523                                 PublicEditor::instance().suspend_route_redisplay ();
 524                         }
 525                 }
 526                 ~DisplaySuspender () {
 527                         if (g_atomic_int_dec_and_test (&PublicEditor::instance()._suspend_route_redisplay_counter)) {
 528                                 PublicEditor::instance().resume_route_redisplay ();
 529                         }
 530                 }
 531 };
 532
 533 class MainMenuDisabler {
 534 public:
 535         MainMenuDisabler () {
 536                 /* The global menu bar continues to be accessible to applications
 537                    with modal dialogs on mac, which means that we need to desensitize
 538                    all items in the menu bar.
 539                 */
 540                 ActionManager::disable_active_actions ();
 541         }
 542
 543         ~MainMenuDisabler () {
 544                 ActionManager::enable_active_actions ();
 545         }
 546 };
 547
 548 #endif // __gtk_ardour_public_editor_h__