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