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