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