gtk2_ardour/public_editor.h

   1 /*
   2     Copyright (C) 2000-2007 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 __gtk_ardour_public_editor_h__
  21 #define __gtk_ardour_public_editor_h__
  22
  23 #ifdef WAF_BUILD
  24 #include "gtk2ardour-config.h"
  25 #endif
  26
  27 #include <map>
  28
  29 #include <string>
  30 #include <glib.h>
  31 #include <gdk/gdktypes.h>
  32 #include <gtkmm/box.h>
  33 #include <gtkmm/window.h>
  34 #include <gtkmm/actiongroup.h>
  35 #include <gtkmm/notebook.h>
  36 #include <sigc++/signal.h>
  37
  38 #include "evoral/Beats.hpp"
  39 #include "evoral/Note.hpp"
  40
  41 #include "pbd/statefuldestructible.h"
  42
  43 #include "canvas/fwd.h"
  44
  45 #include "gtkmm2ext/actions.h"
  46 #include "gtkmm2ext/bindings.h"
  47 #include "gtkmm2ext/tabbable.h"
  48 #include "gtkmm2ext/visibility_tracker.h"
  49
  50 #include "editing.h"
  51 #include "selection.h"
  52
  53 namespace ARDOUR {
  54         class Session;
  55         class Region;
  56         class Playlist;
  57         class RouteGroup;
  58         class Trimmable;
  59         class Movable;
  60         class Stripable;
  61 }
  62
  63 namespace Gtk {
  64         class Container;
  65         class Menu;
  66 }
  67
  68 class AudioRegionView;
  69 class AutomationLine;
  70 class AutomationTimeAxisView;
  71 class ControlPoint;
  72 class DragManager;
  73 class Editor;
  74 class ArdourMarker;
  75 class MeterMarker;
  76 class MouseCursors;
  77 class PlaylistSelector;
  78 class PluginSelector;
  79 class PluginUIWindow;
  80 class RegionView;
  81 class RouteTimeAxisView;
  82 class Selection;
  83 class TempoCurve;
  84 class TempoMarker;
  85 class TimeAxisView;
  86 class TimeAxisViewItem;
  87 class VerboseCursor;
  88 class XMLNode;
  89 struct SelectionRect;
  90
  91 class DisplaySuspender;
  92
  93 namespace ARDOUR_UI_UTILS {
  94 bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
  95 bool forward_key_press (GdkEventKey* ev);
  96 }
  97
  98 using ARDOUR::framepos_t;
  99 using ARDOUR::framecnt_t;
 100
 101 /// Representation of the interface of the Editor class
 102
 103 /** This class contains just the public interface of the Editor class,
 104  * in order to decouple it from the private implementation, so that callers
 105  * of PublicEditor need not be recompiled if private methods or member variables
 106  * change.
 107  */
 108 class PublicEditor : public Gtkmm2ext::Tabbable {
 109   public:
 110         PublicEditor (Gtk::Widget& content);
 111         virtual ~PublicEditor ();
 112
 113         /** @return Singleton PublicEditor instance */
 114         static PublicEditor& instance () { return *_instance; }
 115
 116         virtual bool have_idled() const = 0;
 117         virtual void first_idle() = 0;
 118
 119         virtual void setup_tooltips() = 0;
 120
 121         /** Attach this editor to a Session.
 122          * @param s Session to connect to.
 123          */
 124         virtual void set_session (ARDOUR::Session* s) = 0;
 125
 126         /** @return The Session that we are editing, or 0 */
 127         virtual ARDOUR::Session* session () const = 0;
 128
 129         /** Set the snap type.
 130          * @param t Snap type (defined in editing_syms.h)
 131          */
 132         virtual void set_snap_to (Editing::SnapType t) = 0;
 133
 134         virtual Editing::SnapType snap_type () const = 0;
 135         virtual Editing::SnapMode snap_mode () const = 0;
 136
 137         /** Set the snap mode.
 138          * @param m Snap mode (defined in editing_syms.h)
 139          */
 140         virtual void set_snap_mode (Editing::SnapMode m) = 0;
 141
 142         /** Set the snap threshold.
 143          * @param t Snap threshold in `units'.
 144          */
 145         virtual void set_snap_threshold (double t) = 0;
 146
 147         /**
 148          * Snap a value according to the current snap setting.
 149          * ensure_snap overrides SnapOff and magnetic snap
 150          */
 151         virtual void snap_to (framepos_t&       first,
 152                               ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
 153                               bool              for_mark  = false,
 154                               bool              ensure_snap = false) = 0;
 155
 156         /** Undo some transactions.
 157          * @param n Number of transactions to undo.
 158          */
 159
 160         virtual void undo (uint32_t n = 1) = 0;
 161
 162         /** Redo some transactions.
 163          * @param n Number of transaction to redo.
 164          */
 165         virtual void redo (uint32_t n = 1) = 0;
 166
 167         /** Set the mouse mode (gain, object, range, timefx etc.)
 168          * @param m Mouse mode (defined in editing_syms.h)
 169          * @param force Perform the effects of the change even if no change is required
 170          * (ie even if the current mouse mode is equal to @param m)
 171          */
 172         virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
 173
 174         /** Step the mouse mode onto the next or previous one.
 175          * @param next true to move to the next, otherwise move to the previous
 176          */
 177         virtual void step_mouse_mode (bool next) = 0;
 178
 179         /** @return The current mouse mode (gain, object, range, timefx etc.)
 180          * (defined in editing_syms.h)
 181          */
 182         virtual Editing::MouseMode current_mouse_mode () const = 0;
 183
 184         /** @return Whether the current mouse mode is an "internal" editing mode.
 185          */
 186         virtual bool internal_editing() const = 0;
 187
 188         /** Possibly start the audition of a region.  If @param r is 0, or not an AudioRegion
 189          * any current audition is cancelled.  If we are currently auditioning @param r,
 190          * the audition will be cancelled.  Otherwise an audition of @param r will start.
 191          * \param r Region to consider.
 192          */
 193         virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
 194
 195         virtual void new_region_from_selection () = 0;
 196         virtual void separate_region_from_selection () = 0;
 197
 198         virtual void transition_to_rolling (bool fwd) = 0;
 199         virtual framepos_t pixel_to_sample (double pixel) const = 0;
 200         virtual double sample_to_pixel (framepos_t frame) const = 0;
 201         virtual double sample_to_pixel_unrounded (framepos_t frame) const = 0;
 202         virtual Selection& get_selection () const = 0;
 203         virtual bool get_selection_extents (framepos_t &start, framepos_t &end) const = 0;
 204         virtual Selection& get_cut_buffer () const = 0;
 205         virtual void track_mixer_selection () = 0;
 206         virtual bool extend_selection_to_track (TimeAxisView&) = 0;
 207         virtual void play_selection () = 0;
 208         virtual void play_with_preroll () = 0;
 209         virtual void maybe_locate_with_edit_preroll (framepos_t location) = 0;
 210         virtual void goto_nth_marker (int nth) = 0;
 211         virtual void trigger_script (int nth) = 0;
 212         virtual void add_location_from_playhead_cursor () = 0;
 213         virtual void remove_location_at_playhead_cursor () = 0;
 214         virtual void set_show_measures (bool yn) = 0;
 215         virtual bool show_measures () const = 0;
 216         virtual void remove_tracks () = 0;
 217         virtual void set_loop_range (framepos_t start, framepos_t end, std::string cmd) = 0;
 218         virtual void set_punch_range (framepos_t start, framepos_t end, std::string cmd) = 0;
 219
 220         virtual Editing::MouseMode effective_mouse_mode () const = 0;
 221
 222         /** Import existing media */
 223         virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality, framepos_t&, boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
 224         virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,  framepos_t&, boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
 225
 226         /** Open main export dialog */
 227         virtual void export_audio () = 0;
 228
 229         /** Open stem export dialog */
 230         virtual void stem_export () = 0;
 231
 232         /** Open export dialog with current selection pre-selected */
 233         virtual void export_selection () = 0;
 234
 235         /** Open export dialog with current range pre-selected */
 236         virtual void export_range () = 0;
 237
 238         virtual void register_actions () = 0;
 239         virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
 240         virtual Editing::ZoomFocus get_zoom_focus () const = 0;
 241         virtual framecnt_t get_current_zoom () const = 0;
 242         virtual void reset_zoom (framecnt_t) = 0;
 243         virtual PlaylistSelector& playlist_selector() const = 0;
 244         virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
 245         virtual void new_playlists (TimeAxisView*) = 0;
 246         virtual void copy_playlists (TimeAxisView*) = 0;
 247         virtual void clear_playlists (TimeAxisView*) = 0;
 248         virtual void select_all_tracks () = 0;
 249         virtual void deselect_all () = 0;
 250         virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
 251         virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
 252         virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
 253
 254         virtual void set_stationary_playhead (bool yn) = 0;
 255         virtual void toggle_stationary_playhead () = 0;
 256         virtual bool stationary_playhead() const = 0;
 257
 258         /** Set whether the editor should follow the playhead.
 259          * @param yn true to follow playhead, otherwise false.
 260          * @param catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
 261          */
 262         virtual void set_follow_playhead (bool yn, bool catch_up = false) = 0;
 263
 264         /** Toggle whether the editor is following the playhead */
 265         virtual void toggle_follow_playhead () = 0;
 266
 267         /** @return true if the editor is following the playhead */
 268         virtual bool follow_playhead () const = 0;
 269
 270         /** @return true if the playhead is currently being dragged, otherwise false */
 271         virtual bool dragging_playhead () const = 0;
 272         virtual framepos_t leftmost_sample() const = 0;
 273         virtual framecnt_t current_page_samples() const = 0;
 274         virtual double visible_canvas_height () const = 0;
 275         virtual void temporal_zoom_step (bool coarser) = 0;
 276         virtual void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top = false) = 0;
 277         virtual void override_visible_track_count () = 0;
 278         virtual void scroll_tracks_down_line () = 0;
 279         virtual void scroll_tracks_up_line () = 0;
 280         virtual bool scroll_down_one_track (bool skip_child_views = false) = 0;
 281         virtual bool scroll_up_one_track (bool skip_child_views = false) = 0;
 282         virtual void prepare_for_cleanup () = 0;
 283         virtual void finish_cleanup () = 0;
 284         virtual void reset_x_origin (framepos_t frame) = 0;
 285         virtual double get_y_origin () const = 0;
 286         virtual void reset_y_origin (double pos) = 0;
 287         virtual void remove_last_capture () = 0;
 288         virtual void maximise_editing_space () = 0;
 289         virtual void restore_editing_space () = 0;
 290         virtual framepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE, bool from_context_menu = false, bool from_outside_canvas = false) = 0;
 291         virtual void toggle_meter_updating() = 0;
 292         virtual void split_regions_at (framepos_t, RegionSelection&, const int32_t sub_num) = 0;
 293         virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
 294         virtual void mouse_add_new_marker (framepos_t where, bool is_cd=false) = 0;
 295         virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
 296         virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
 297         virtual framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next) = 0;
 298         virtual framecnt_t get_paste_offset (framepos_t pos, unsigned paste_count, framecnt_t duration) = 0;
 299         virtual unsigned get_grid_beat_divisions(framepos_t position) = 0;
 300         virtual Evoral::Beats get_grid_type_as_beats (bool& success, framepos_t position) = 0;
 301         virtual unsigned get_grid_music_divisions (uint32_t event_state) = 0;
 302         virtual void edit_notes (MidiRegionView*) = 0;
 303
 304         virtual void queue_visual_videotimeline_update () = 0;
 305         virtual void set_close_video_sensitive (bool) = 0;
 306         virtual void toggle_ruler_video (bool) = 0;
 307         virtual void toggle_xjadeo_proc (int) = 0;
 308         virtual void toggle_xjadeo_viewoption (int, int) = 0;
 309         virtual void set_xjadeo_sensitive (bool onoff) = 0;
 310         virtual int  get_videotl_bar_height () const = 0;
 311         virtual void set_video_timeline_height (const int h) = 0;
 312         virtual void embed_audio_from_video (std::string, framepos_t n = 0, bool lock_position_to_video = true) = 0;
 313
 314         virtual RouteTimeAxisView* get_route_view_by_route_id (const PBD::ID& id) const = 0;
 315
 316         virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, PBD::PropertyID) const = 0;
 317
 318         sigc::signal<void> ZoomChanged;
 319         sigc::signal<void> Realized;
 320         sigc::signal<void,framepos_t> UpdateAllTransportClocks;
 321
 322         static sigc::signal<void> DropDownKeys;
 323
 324         Glib::RefPtr<Gtk::ActionGroup> editor_actions;
 325         Glib::RefPtr<Gtk::ActionGroup> editor_menu_actions;
 326         Glib::RefPtr<Gtk::ActionGroup> _region_actions;
 327
 328         virtual void reset_focus (Gtk::Widget*) = 0;
 329
 330         virtual bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas) = 0;
 331         virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
 332         virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
 333         virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 334         virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 335         virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 336         virtual bool canvas_start_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 337         virtual bool canvas_end_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 338         virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 339         virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
 340         virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 341         virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
 342         virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 343         virtual bool canvas_wave_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 344         virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 345         virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 346         virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 347         virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 348         virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
 349         virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, ArdourMarker*) = 0;
 350         virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 351         virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
 352         virtual bool canvas_tempo_curve_event (GdkEvent* event, ArdourCanvas::Item*, TempoCurve*) = 0;
 353         virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
 354         virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
 355
 356         virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 357         virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 358         virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 359         virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 360         virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 361         virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 362
 363         static const int window_border_width;
 364         static const int container_border_width;
 365         static const int vertical_spacing;
 366         static const int horizontal_spacing;
 367
 368         virtual ArdourCanvas::Container* get_trackview_group () const = 0;
 369         virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
 370         virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
 371         virtual ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const = 0;
 372
 373         virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
 374
 375         virtual TimeAxisView* axis_view_from_stripable (boost::shared_ptr<ARDOUR::Stripable>) const = 0;
 376
 377         virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
 378         virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
 379
 380         virtual void center_screen (framepos_t) = 0;
 381
 382         virtual TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const = 0;
 383         virtual TrackViewList const & get_track_views () = 0;
 384
 385         virtual DragManager* drags () const = 0;
 386         virtual void maybe_autoscroll (bool, bool, bool from_headers) = 0;
 387         virtual void stop_canvas_autoscroll () = 0;
 388         virtual bool autoscroll_active() const = 0;
 389
 390         virtual void begin_reversible_selection_op (std::string cmd_name) = 0;
 391         virtual void commit_reversible_selection_op () = 0;
 392         virtual void begin_reversible_command (std::string cmd_name) = 0;
 393         virtual void begin_reversible_command (GQuark) = 0;
 394         virtual void abort_reversible_command () = 0;
 395         virtual void commit_reversible_command () = 0;
 396
 397         virtual void access_action (std::string,std::string) = 0;
 398
 399         virtual MouseCursors const * cursors () const = 0;
 400         virtual VerboseCursor * verbose_cursor () const = 0;
 401
 402         virtual bool get_smart_mode () const = 0;
 403
 404         virtual void get_pointer_position (double &, double &) const = 0;
 405
 406         virtual ARDOUR::Location* find_location_from_marker (ArdourMarker *, bool &) const = 0;
 407         virtual ArdourMarker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
 408
 409         virtual void snap_to_with_modifier (framepos_t &      first,
 410                                             GdkEvent const *  ev,
 411                                             ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
 412                                             bool              for_mark  = false) = 0;
 413
 414         virtual void get_regions_at (RegionSelection &, framepos_t where, TrackViewList const &) const = 0;
 415         virtual void get_regions_after (RegionSelection&, framepos_t where, const TrackViewList& ts) const = 0;
 416         virtual RegionSelection get_regions_from_selection_and_mouse (framepos_t) = 0;
 417         virtual void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const = 0;
 418         virtual void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > > >&) const = 0;
 419
 420         virtual void mouse_add_new_tempo_event (framepos_t where) = 0;
 421         virtual void mouse_add_new_meter_event (framepos_t where) = 0;
 422         virtual void edit_tempo_section (ARDOUR::TempoSection*) = 0;
 423         virtual void edit_meter_section (ARDOUR::MeterSection*) = 0;
 424
 425         /// Singleton instance, set up by Editor::Editor()
 426
 427         static PublicEditor* _instance;
 428
 429         friend bool ARDOUR_UI_UTILS::relay_key_press (GdkEventKey*, Gtk::Window*);
 430         friend bool ARDOUR_UI_UTILS::forward_key_press (GdkEventKey*);
 431
 432         PBD::Signal0<void> SnapChanged;
 433         PBD::Signal0<void> MouseModeChanged;
 434
 435         Gtkmm2ext::Bindings* bindings;
 436
 437   protected:
 438         friend class DisplaySuspender;
 439         virtual void suspend_route_redisplay () = 0;
 440         virtual void resume_route_redisplay () = 0;
 441         gint _suspend_route_redisplay_counter;
 442 };
 443
 444 class DisplaySuspender {
 445         public:
 446                 DisplaySuspender() {
 447                         if (g_atomic_int_add(&PublicEditor::instance()._suspend_route_redisplay_counter, 1) == 0) {
 448                                 PublicEditor::instance().suspend_route_redisplay ();
 449                         }
 450                 }
 451                 ~DisplaySuspender () {
 452                         if (g_atomic_int_dec_and_test (&PublicEditor::instance()._suspend_route_redisplay_counter)) {
 453                                 PublicEditor::instance().resume_route_redisplay ();
 454                         }
 455                 }
 456 };
 457
 458 class MainMenuDisabler {
 459 public:
 460         MainMenuDisabler () {
 461                 /* The global menu bar continues to be accessible to applications
 462                    with modal dialogs on mac, which means that we need to desensitize
 463                    all items in the menu bar.
 464                 */
 465                 ActionManager::disable_active_actions ();
 466         }
 467
 468         ~MainMenuDisabler () {
 469                 ActionManager::enable_active_actions ();
 470         }
 471 };
 472
 473 #endif // __gtk_ardour_public_editor_h__