gtk2_ardour/editor_drag.h

   1 /*
   2     Copyright (C) 2009 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 __gtk2_ardour_editor_drag_h_
  21 #define __gtk2_ardour_editor_drag_h_
  22
  23 #include <list>
  24
  25 #include <gdk/gdk.h>
  26 #include <stdint.h>
  27
  28 #include "ardour/tempo.h"
  29 #include "ardour/types.h"
  30
  31 #include "canvas/types.h"
  32
  33 #include "cursor_context.h"
  34 #include "editor_items.h"
  35 #include "mouse_cursors.h"
  36 #include "editing.h"
  37
  38 namespace ARDOUR {
  39         class Location;
  40         class TempoSection;
  41 }
  42
  43 namespace ArdourCanvas {
  44         class Item;
  45         class Line;
  46         class Rectangle;
  47 }
  48
  49 namespace PBD {
  50         class StatefulDiffCommand;
  51 }
  52
  53 class PatchChange;
  54 class Editor;
  55 class EditorCursor;
  56 class TimeAxisView;
  57 class MidiTimeAxisView;
  58 class Drag;
  59 class NoteBase;
  60 class RegionView;
  61 class TimeAxisView;
  62 class RouteTimeAxisView;
  63 class RegionSelection;
  64 class MidiRegionView;
  65 class MeterMarker;
  66 class ArdourMarker;
  67 class TempoMarker;
  68 class ControlPoint;
  69 class AudioRegionView;
  70 class AutomationLine;
  71 class AutomationTimeAxisView;
  72
  73 /** Class to manage current drags */
  74 class DragManager
  75 {
  76 public:
  77
  78         DragManager (Editor* e);
  79         ~DragManager ();
  80
  81         bool motion_handler (GdkEvent *, bool);
  82
  83         void abort ();
  84         void add (Drag *);
  85         void set (Drag *, GdkEvent *, Gdk::Cursor* c = MouseCursors::invalid_cursor());
  86         void start_grab (GdkEvent *, Gdk::Cursor* c = MouseCursors::invalid_cursor());
  87         bool end_grab (GdkEvent *);
  88         bool have_item (ArdourCanvas::Item *) const;
  89
  90         void mark_double_click ();
  91
  92         /** @return true if an end drag or abort is in progress */
  93         bool ending () const {
  94                 return _ending;
  95         }
  96
  97         bool active () const {
  98                 return !_drags.empty ();
  99         }
 100
 101         /** @return current pointer x position in canvas coordinates */
 102         double current_pointer_x () const {
 103                 return _current_pointer_x;
 104         }
 105
 106         /** @return current pointer y position in canvas coordinates */
 107         double current_pointer_y () const {
 108                 return _current_pointer_y;
 109         }
 110
 111         /** @return current pointer frame */
 112         ARDOUR::framepos_t current_pointer_frame () const {
 113                 return _current_pointer_frame;
 114         }
 115
 116 private:
 117         Editor* _editor;
 118         std::list<Drag*> _drags;
 119         bool _ending; ///< true if end_grab or abort is in progress, otherwise false
 120         double _current_pointer_x; ///< canvas-coordinate space x of the current pointer
 121         double _current_pointer_y; ///< canvas-coordinate space y of the current pointer
 122         ARDOUR::framepos_t _current_pointer_frame; ///< frame that the pointer is now at
 123         bool _old_follow_playhead; ///< state of Editor::follow_playhead() before the drags started
 124 };
 125
 126 /** Abstract base class for dragging of things within the editor */
 127 class Drag
 128 {
 129 public:
 130         Drag (Editor *, ArdourCanvas::Item *, bool trackview_only = true);
 131         virtual ~Drag () {}
 132
 133         void set_manager (DragManager* m) {
 134                 _drags = m;
 135         }
 136
 137         /** @return the canvas item being dragged */
 138         ArdourCanvas::Item* item () const {
 139                 return _item;
 140         }
 141
 142         void swap_grab (ArdourCanvas::Item *, Gdk::Cursor *, uint32_t);
 143         bool motion_handler (GdkEvent*, bool);
 144         void abort ();
 145
 146         ARDOUR::framepos_t adjusted_frame (ARDOUR::framepos_t, GdkEvent const *, bool snap = true) const;
 147         ARDOUR::framepos_t adjusted_current_frame (GdkEvent const *, bool snap = true) const;
 148
 149         bool was_double_click() const { return _was_double_click; }
 150         void set_double_click (bool yn) { _was_double_click = yn; }
 151
 152         /** Called to start a grab of an item.
 153          *  @param e Event that caused the grab to start.
 154          *  @param c Cursor to use, or 0.
 155          */
 156         virtual void start_grab (GdkEvent* e, Gdk::Cursor* c = 0);
 157
 158         virtual bool end_grab (GdkEvent *);
 159
 160         /** Called when a drag motion has occurred.
 161          *  @param e Event describing the motion.
 162          *  @param f true if this is the first movement, otherwise false.
 163          */
 164         virtual void motion (GdkEvent* e, bool f) = 0;
 165
 166         /** Called when a drag has finished.
 167          *  @param e Event describing the finish.
 168          *  @param m true if some movement occurred, otherwise false.
 169          */
 170         virtual void finished (GdkEvent* e, bool m) = 0;
 171
 172         /** Called to abort a drag and return things to how
 173          *  they were before it started.
 174          *  @param m true if some movement occurred, otherwise false.
 175          */
 176         virtual void aborted (bool m) = 0;
 177
 178         /** @param m Mouse mode.
 179          *  @return true if this drag should happen in this mouse mode.
 180          */
 181         virtual bool active (Editing::MouseMode m) {
 182                 return true;
 183         }
 184
 185         /** @return minimum number of frames (in x) and pixels (in y) that should be considered a movement */
 186         virtual std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
 187                 return std::make_pair (1, 1);
 188         }
 189
 190         virtual bool allow_vertical_autoscroll () const {
 191                 return true;
 192         }
 193
 194         /** @return true if x movement matters to this drag */
 195         virtual bool x_movement_matters () const {
 196                 return true;
 197         }
 198
 199         /** @return true if y movement matters to this drag */
 200         virtual bool y_movement_matters () const {
 201                 return true;
 202         }
 203
 204         bool initially_vertical() const {
 205                 return _initially_vertical;
 206         }
 207
 208         /** Set up the _pointer_frame_offset */
 209         virtual void setup_pointer_frame_offset () {
 210                 _pointer_frame_offset = 0;
 211         }
 212
 213 protected:
 214
 215         double grab_x () const {
 216                 return _grab_x;
 217         }
 218
 219         double grab_y () const {
 220                 return _grab_y;
 221         }
 222
 223         ARDOUR::framepos_t raw_grab_frame () const {
 224                 return _raw_grab_frame;
 225         }
 226
 227         ARDOUR::framepos_t grab_frame () const {
 228                 return _grab_frame;
 229         }
 230
 231         double last_pointer_x () const {
 232                 return _last_pointer_x;
 233         }
 234
 235         double last_pointer_y () const {
 236                 return _last_pointer_y;
 237         }
 238
 239         ARDOUR::framepos_t last_pointer_frame () const {
 240                 return _last_pointer_frame;
 241         }
 242
 243         ARDOUR::frameoffset_t snap_delta (guint const) const;
 244
 245         double current_pointer_x () const;
 246         double current_pointer_y () const;
 247
 248         /* sets snap delta from unsnapped pos */
 249         void setup_snap_delta (framepos_t pos);
 250
 251         boost::shared_ptr<ARDOUR::Region> add_midi_region (MidiTimeAxisView*, bool commit, const int32_t sub_num);
 252
 253         void show_verbose_cursor_time (framepos_t);
 254         void show_verbose_cursor_duration (framepos_t, framepos_t, double xoffset = 0);
 255         void show_verbose_cursor_text (std::string const &);
 256
 257         Editor* _editor; ///< our editor
 258         DragManager* _drags;
 259         ArdourCanvas::Item* _item; ///< our item
 260         /** Offset from the mouse's position for the drag to the start of the thing that is being dragged */
 261         ARDOUR::framecnt_t _pointer_frame_offset;
 262         bool _x_constrained; ///< true if x motion is constrained, otherwise false
 263         bool _y_constrained; ///< true if y motion is constrained, otherwise false
 264         bool _was_rolling; ///< true if the session was rolling before the drag started, otherwise false
 265
 266 private:
 267         bool _trackview_only; ///< true if pointer y value should always be relative to the top of the trackview group
 268         bool _move_threshold_passed; ///< true if the move threshold has been passed, otherwise false
 269         bool _starting_point_passed; ///< true if we called move () with first_move flag, otherwise false
 270         bool _initially_vertical; ///< true if after move threshold is passed we appear to be moving vertically; undefined before that
 271         bool _was_double_click; ///< true if drag initiated by a double click event
 272         double _grab_x; ///< trackview x of the grab start position
 273         double _grab_y; ///< y of the grab start position, possibly adjusted if _trackview_only is true
 274         double _last_pointer_x; ///< trackview x of the pointer last time a motion occurred
 275         double _last_pointer_y; ///< trackview y of the pointer last time a motion occurred
 276         ARDOUR::framepos_t _raw_grab_frame; ///< unsnapped frame that the mouse was at when start_grab was called, or 0
 277         ARDOUR::framepos_t _grab_frame; ///< adjusted_frame that the mouse was at when start_grab was called, or 0
 278         ARDOUR::framepos_t _last_pointer_frame; ///< adjusted_frame the last time a motion occurred
 279
 280         /* difference between some key position's snapped and unsnapped
 281          *  framepos. used for relative snap.
 282          */
 283         ARDOUR::frameoffset_t _snap_delta;
 284         CursorContext::Handle _cursor_ctx; ///< cursor change context
 285         bool _constraint_pressed; ///< if the keyboard indicated constraint modifier was pressed on start_grab()
 286 };
 287
 288 class RegionDrag;
 289
 290 /** Container for details about a region being dragged */
 291 class DraggingView
 292 {
 293 public:
 294         DraggingView (RegionView *, RegionDrag *, TimeAxisView* original_tav);
 295
 296         RegionView* view; ///< the view
 297         /** index into RegionDrag::_time_axis_views of the view that this region is currently being displayed on,
 298          *  or -1 if it is not visible.
 299          */
 300         int time_axis_view;
 301         /** layer that this region is currently being displayed on.  This is a double
 302             rather than a layer_t as we use fractional layers during drags to allow the user
 303             to indicate a new layer to put a region on.
 304         */
 305         double layer;
 306         double initial_y; ///< the initial y position of the view before any reparenting
 307         framepos_t initial_position; ///< initial position of the region
 308         framepos_t initial_end; ///< initial end position of the region
 309         framepos_t anchored_fade_length; ///< fade_length when anchored during drag
 310         boost::shared_ptr<ARDOUR::Playlist> initial_playlist;
 311         TimeAxisView* initial_time_axis_view;
 312 };
 313
 314 /** Abstract base class for drags that involve region(s) */
 315 class RegionDrag : public Drag, public sigc::trackable
 316 {
 317 public:
 318         RegionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 319         virtual ~RegionDrag () {}
 320
 321 protected:
 322
 323         RegionView* _primary; ///< the view that was clicked on (or whatever) to start the drag
 324         std::list<DraggingView> _views; ///< information about all views that are being dragged
 325
 326         /** a list of the non-hidden TimeAxisViews sorted by editor order key */
 327         std::vector<TimeAxisView*> _time_axis_views;
 328         int find_time_axis_view (TimeAxisView *) const;
 329         int apply_track_delta (const int start, const int delta, const int skip, const bool distance_only = false) const;
 330         int32_t current_music_divisor (framepos_t pos, int32_t button_state);
 331
 332         int _visible_y_low;
 333         int _visible_y_high;
 334         uint32_t _ntracks;
 335
 336         friend class DraggingView;
 337
 338 private:
 339
 340         void region_going_away (RegionView *);
 341         PBD::ScopedConnection death_connection;
 342 };
 343
 344
 345 /** Drags involving region motion from somewhere */
 346 class RegionMotionDrag : public RegionDrag
 347 {
 348 public:
 349
 350         RegionMotionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool);
 351         virtual ~RegionMotionDrag () {}
 352
 353         virtual void start_grab (GdkEvent *, Gdk::Cursor *);
 354         virtual void motion (GdkEvent *, bool);
 355         virtual void finished (GdkEvent *, bool);
 356         virtual void aborted (bool);
 357
 358         /** @return true if the regions being `moved' came from somewhere on the canvas;
 359          *  false if they came from outside (e.g. from the region list).
 360          */
 361         virtual bool regions_came_from_canvas () const = 0;
 362
 363 protected:
 364
 365         double compute_x_delta (GdkEvent const *, ARDOUR::framepos_t *);
 366         virtual bool y_movement_allowed (int, double, int skip_invisible = 0) const;
 367
 368         bool _brushing;
 369         bool _ignore_video_lock;
 370         ARDOUR::framepos_t _last_frame_position; ///< last position of the thing being dragged
 371         double _total_x_delta;
 372         int _last_pointer_time_axis_view;
 373         double _last_pointer_layer;
 374 private:
 375         uint32_t _ndropzone;
 376         uint32_t _pdropzone;
 377         uint32_t _ddropzone;
 378 };
 379
 380
 381 /** Drags to move (or copy) regions that are already shown in the GUI to
 382  *  somewhere different.
 383  */
 384 class RegionMoveDrag : public RegionMotionDrag
 385 {
 386 public:
 387         RegionMoveDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool, bool);
 388         virtual ~RegionMoveDrag () {}
 389
 390         void motion (GdkEvent *, bool);
 391         void finished (GdkEvent *, bool);
 392         void aborted (bool);
 393
 394         bool regions_came_from_canvas () const {
 395                 return true;
 396         }
 397
 398         std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
 399                 return std::make_pair (4, 4);
 400         }
 401
 402         void setup_pointer_frame_offset ();
 403
 404 protected:
 405         typedef std::set<boost::shared_ptr<ARDOUR::Playlist> > PlaylistSet;
 406         void add_stateful_diff_commands_for_playlists (PlaylistSet const &);
 407
 408 private:
 409         void finished_no_copy (
 410                 bool const,
 411                 bool const,
 412                 ARDOUR::framecnt_t const,
 413                 int32_t const ev_state
 414                 );
 415
 416         void finished_copy (
 417                 bool const,
 418                 bool const,
 419                 ARDOUR::framecnt_t const,
 420                 int32_t const ev_state
 421                 );
 422
 423         RegionView* insert_region_into_playlist (
 424                 boost::shared_ptr<ARDOUR::Region>,
 425                 RouteTimeAxisView*,
 426                 ARDOUR::layer_t,
 427                 ARDOUR::framecnt_t,
 428                 PlaylistSet&,
 429                 const int32_t sub_num
 430                 );
 431
 432         void remove_region_from_playlist (
 433                 boost::shared_ptr<ARDOUR::Region>,
 434                 boost::shared_ptr<ARDOUR::Playlist>,
 435                 PlaylistSet& modified_playlists
 436                 );
 437
 438
 439         void collect_new_region_view (RegionView *);
 440         RouteTimeAxisView* create_destination_time_axis (boost::shared_ptr<ARDOUR::Region>, TimeAxisView* original);
 441
 442         bool _copy;
 443         RegionView* _new_region_view;
 444 };
 445
 446 /** Drag to insert a region from somewhere */
 447 class RegionInsertDrag : public RegionMotionDrag
 448 {
 449 public:
 450         RegionInsertDrag (Editor *, boost::shared_ptr<ARDOUR::Region>, RouteTimeAxisView*, ARDOUR::framepos_t);
 451
 452         void finished (GdkEvent *, bool);
 453         void aborted (bool);
 454
 455         bool regions_came_from_canvas () const {
 456                 return false;
 457         }
 458 };
 459
 460 /** Region drag in splice mode */
 461 class RegionSpliceDrag : public RegionMoveDrag
 462 {
 463 public:
 464         RegionSpliceDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 465
 466         void motion (GdkEvent *, bool);
 467         void finished (GdkEvent *, bool);
 468         void aborted (bool);
 469 };
 470
 471 /** Region drag in ripple mode */
 472
 473 class RegionRippleDrag : public RegionMoveDrag
 474 {
 475 public:
 476         RegionRippleDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 477         ~RegionRippleDrag () { delete exclude; }
 478
 479         void motion (GdkEvent *, bool);
 480         void finished (GdkEvent *, bool);
 481         void aborted (bool);
 482 protected:
 483         bool y_movement_allowed (int delta_track, double delta_layer, int skip_invisible = 0) const;
 484
 485 private:
 486         TimeAxisView *prev_tav;         // where regions were most recently dragged from
 487         TimeAxisView *orig_tav;         // where drag started
 488         ARDOUR::framecnt_t prev_amount;
 489         ARDOUR::framepos_t prev_position;
 490         ARDOUR::framecnt_t selection_length;
 491         bool allow_moves_across_tracks; // only if all selected regions are on one track
 492         ARDOUR::RegionList *exclude;
 493         void add_all_after_to_views (TimeAxisView *tav, ARDOUR::framepos_t where, const RegionSelection &exclude, bool drag_in_progress);
 494         void remove_unselected_from_views (ARDOUR::framecnt_t amount, bool move_regions);
 495
 496 };
 497
 498 /** "Drag" to cut a region (action only on button release) */
 499 class RegionCutDrag : public Drag
 500 {
 501     public:
 502         RegionCutDrag (Editor*, ArdourCanvas::Item*, framepos_t);
 503         ~RegionCutDrag ();
 504
 505         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 506         void motion (GdkEvent*, bool);
 507         void finished (GdkEvent*, bool);
 508         void aborted (bool);
 509
 510     private:
 511         EditorCursor* line;
 512 };
 513
 514 /** Drags to create regions */
 515 class RegionCreateDrag : public Drag
 516 {
 517 public:
 518         RegionCreateDrag (Editor *, ArdourCanvas::Item *, TimeAxisView *);
 519
 520         void motion (GdkEvent *, bool);
 521         void finished (GdkEvent *, bool);
 522         void aborted (bool);
 523
 524 private:
 525         MidiTimeAxisView* _view;
 526         boost::shared_ptr<ARDOUR::Region> _region;
 527 };
 528
 529 /** Drags to resize MIDI notes */
 530 class NoteResizeDrag : public Drag
 531 {
 532 public:
 533         NoteResizeDrag (Editor *, ArdourCanvas::Item *);
 534
 535         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 536         void motion (GdkEvent *, bool);
 537         void finished (GdkEvent *, bool);
 538         void aborted (bool);
 539
 540 private:
 541         MidiRegionView*     region;
 542         bool                relative;
 543         bool                at_front;
 544         bool                _was_selected;
 545         double              _snap_delta;
 546 };
 547
 548 /** Drags to move MIDI notes */
 549 class NoteDrag : public Drag
 550 {
 551   public:
 552         NoteDrag (Editor*, ArdourCanvas::Item*);
 553
 554         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 555         void motion (GdkEvent *, bool);
 556         void finished (GdkEvent *, bool);
 557         void aborted (bool);
 558
 559   private:
 560
 561         ARDOUR::frameoffset_t total_dx (const guint) const;
 562         int8_t total_dy () const;
 563
 564         MidiRegionView* _region;
 565         NoteBase* _primary;
 566         double _cumulative_dx;
 567         double _cumulative_dy;
 568         bool   _was_selected;
 569         double _note_height;
 570 };
 571
 572 class NoteCreateDrag : public Drag
 573 {
 574 public:
 575         NoteCreateDrag (Editor *, ArdourCanvas::Item *, MidiRegionView *);
 576         ~NoteCreateDrag ();
 577
 578         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 579         void motion (GdkEvent *, bool);
 580         void finished (GdkEvent *, bool);
 581         void aborted (bool);
 582
 583         bool active (Editing::MouseMode mode) {
 584                 return mode == Editing::MouseDraw || mode == Editing::MouseContent;
 585         }
 586
 587         bool y_movement_matters () const {
 588                 return false;
 589         }
 590
 591 private:
 592         double y_to_region (double) const;
 593         ARDOUR::framecnt_t grid_frames (framepos_t) const;
 594
 595         /** @return minimum number of frames (in x) and pixels (in y) that should be considered a movement */
 596         virtual std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
 597                 return std::make_pair (0, 0);
 598         }
 599
 600         MidiRegionView* _region_view;
 601         ArdourCanvas::Rectangle* _drag_rect;
 602         framepos_t _note[2];
 603 };
 604
 605 class HitCreateDrag : public Drag
 606 {
 607 public:
 608         HitCreateDrag (Editor *, ArdourCanvas::Item *, MidiRegionView *);
 609         ~HitCreateDrag ();
 610
 611         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 612         void motion (GdkEvent *, bool);
 613         void finished (GdkEvent *, bool);
 614         void aborted (bool);
 615
 616         bool active (Editing::MouseMode mode) {
 617                 return mode == Editing::MouseDraw || mode == Editing::MouseContent;
 618         }
 619
 620         bool y_movement_matters () const {
 621                 return false;
 622         }
 623
 624 private:
 625         double y_to_region (double) const;
 626         ARDOUR::framecnt_t grid_frames (framepos_t) const;
 627
 628         /** @return minimum number of frames (in x) and pixels (in y) that should be considered a movement */
 629         virtual std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
 630                 return std::make_pair (0, 0);
 631         }
 632
 633         MidiRegionView* _region_view;
 634         framepos_t      _last_pos;
 635         double          _last_y;
 636
 637 };
 638
 639 /** Drag to move MIDI patch changes */
 640 class PatchChangeDrag : public Drag
 641 {
 642 public:
 643         PatchChangeDrag (Editor *, PatchChange *, MidiRegionView *);
 644
 645         void motion (GdkEvent *, bool);
 646         void finished (GdkEvent *, bool);
 647         void aborted (bool);
 648
 649         bool y_movement_matters () const {
 650                 return false;
 651         }
 652
 653         void setup_pointer_frame_offset ();
 654
 655 private:
 656         MidiRegionView* _region_view;
 657         PatchChange* _patch_change;
 658         double _cumulative_dx;
 659 };
 660
 661 /** Container for details about audio regions being dragged along with video */
 662 class AVDraggingView
 663 {
 664 public:
 665         AVDraggingView (RegionView *);
 666
 667         RegionView* view; ///< the view
 668         framepos_t initial_position; ///< initial position of the region
 669 };
 670
 671 /** Drag of video offset */
 672 class VideoTimeLineDrag : public Drag
 673 {
 674 public:
 675         VideoTimeLineDrag (Editor *e, ArdourCanvas::Item *i);
 676
 677         void motion (GdkEvent *, bool);
 678         void finished (GdkEvent *, bool);
 679         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 680
 681         bool y_movement_matters () const {
 682                 return false;
 683         }
 684
 685         bool allow_vertical_autoscroll () const {
 686                 return false;
 687         }
 688
 689         void aborted (bool);
 690
 691 protected:
 692         std::list<AVDraggingView> _views; ///< information about all audio that are being dragged along
 693
 694 private:
 695         ARDOUR::frameoffset_t _startdrag_video_offset;
 696         ARDOUR::frameoffset_t _max_backwards_drag;
 697         bool _stuck;
 698 };
 699
 700 /** Drag to trim region(s) */
 701 class TrimDrag : public RegionDrag
 702 {
 703 public:
 704         enum Operation {
 705                 StartTrim,
 706                 EndTrim,
 707                 ContentsTrim,
 708         };
 709
 710         TrimDrag (Editor *, ArdourCanvas::Item *, RegionView*, std::list<RegionView*> const &, bool preserve_fade_anchor = false);
 711
 712         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 713         void motion (GdkEvent *, bool);
 714         void finished (GdkEvent *, bool);
 715         void aborted (bool);
 716
 717         bool y_movement_matters () const {
 718                 return false;
 719         }
 720
 721         void setup_pointer_frame_offset ();
 722
 723 private:
 724
 725         Operation _operation;
 726
 727         bool _preserve_fade_anchor;
 728         bool _jump_position_when_done;
 729 };
 730
 731 /** Meter marker drag */
 732 class MeterMarkerDrag : public Drag
 733 {
 734 public:
 735         MeterMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
 736
 737         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 738         void motion (GdkEvent *, bool);
 739         void finished (GdkEvent *, bool);
 740         void aborted (bool);
 741
 742         bool allow_vertical_autoscroll () const {
 743                 return false;
 744         }
 745
 746         bool y_movement_matters () const {
 747                 return false;
 748         }
 749
 750         void setup_pointer_frame_offset ();
 751
 752 private:
 753         MeterMarker* _marker;
 754         ARDOUR::MeterSection* _real_section;
 755
 756         bool _copy;
 757         Editing::SnapType _old_snap_type;
 758         Editing::SnapMode _old_snap_mode;
 759         XMLNode* before_state;
 760 };
 761
 762 /** Tempo marker drag */
 763 class TempoMarkerDrag : public Drag
 764 {
 765 public:
 766         TempoMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
 767
 768         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 769         void motion (GdkEvent *, bool);
 770         void finished (GdkEvent *, bool);
 771         void aborted (bool);
 772
 773         bool allow_vertical_autoscroll () const {
 774                 return false;
 775         }
 776
 777         bool y_movement_matters () const {
 778                 return true;
 779         }
 780
 781         void setup_pointer_frame_offset ();
 782
 783 private:
 784         TempoMarker* _marker;
 785         ARDOUR::TempoSection* _real_section;
 786
 787         bool _copy;
 788         bool _movable;
 789         double _grab_bpm;
 790         XMLNode* before_state;
 791 };
 792
 793 /** BBT Ruler drag */
 794 class BBTRulerDrag : public Drag
 795 {
 796 public:
 797         BBTRulerDrag (Editor *, ArdourCanvas::Item *);
 798
 799         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 800         void motion (GdkEvent *, bool);
 801         void finished (GdkEvent *, bool);
 802         void aborted (bool);
 803
 804         bool allow_vertical_autoscroll () const {
 805                 return false;
 806         }
 807
 808         bool y_movement_matters () const {
 809                 return false;
 810         }
 811
 812         void setup_pointer_frame_offset ();
 813
 814 private:
 815         double _grab_qn;
 816         ARDOUR::TempoSection* _tempo;
 817         XMLNode* before_state;
 818 };
 819
 820 /** Drag of the playhead cursor */
 821 class CursorDrag : public Drag
 822 {
 823 public:
 824         CursorDrag (Editor *, EditorCursor&, bool);
 825
 826         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 827         void motion (GdkEvent *, bool);
 828         void finished (GdkEvent *, bool);
 829         void aborted (bool);
 830
 831         bool allow_vertical_autoscroll () const {
 832                 return false;
 833         }
 834
 835         bool y_movement_matters () const {
 836                 return true;
 837         }
 838
 839 private:
 840         void fake_locate (framepos_t);
 841
 842         EditorCursor& _cursor;
 843         bool _stop; ///< true to stop the transport on starting the drag, otherwise false
 844         double _grab_zoom; ///< editor frames per unit when our grab started
 845 };
 846
 847 /** Region fade-in drag */
 848 class FadeInDrag : public RegionDrag
 849 {
 850 public:
 851         FadeInDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 852
 853         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 854         void motion (GdkEvent *, bool);
 855         void finished (GdkEvent *, bool);
 856         void aborted (bool);
 857
 858         bool y_movement_matters () const {
 859                 return false;
 860         }
 861
 862         void setup_pointer_frame_offset ();
 863 };
 864
 865 /** Region fade-out drag */
 866 class FadeOutDrag : public RegionDrag
 867 {
 868 public:
 869         FadeOutDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 870
 871         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 872         void motion (GdkEvent *, bool);
 873         void finished (GdkEvent *, bool);
 874         void aborted (bool);
 875
 876         bool y_movement_matters () const {
 877                 return false;
 878         }
 879
 880         void setup_pointer_frame_offset ();
 881 };
 882
 883 /** Marker drag */
 884 class MarkerDrag : public Drag
 885 {
 886 public:
 887         MarkerDrag (Editor *, ArdourCanvas::Item *);
 888         ~MarkerDrag ();
 889
 890         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 891         void motion (GdkEvent *, bool);
 892         void finished (GdkEvent *, bool);
 893         void aborted (bool);
 894
 895         bool allow_vertical_autoscroll () const {
 896                 return false;
 897         }
 898
 899         bool y_movement_matters () const {
 900                 return false;
 901         }
 902
 903         void setup_pointer_frame_offset ();
 904
 905 private:
 906         void update_item (ARDOUR::Location *);
 907
 908         ArdourMarker* _marker; ///< marker being dragged
 909         bool _selection_changed;
 910         struct CopiedLocationMarkerInfo {
 911             ARDOUR::Location* location;
 912             std::vector<ArdourMarker*> markers;
 913             bool    move_both;
 914             CopiedLocationMarkerInfo (ARDOUR::Location* l, ArdourMarker* m);
 915         };
 916
 917         typedef std::list<CopiedLocationMarkerInfo> CopiedLocationInfo;
 918         CopiedLocationInfo _copied_locations;
 919         ArdourCanvas::Points _points;
 920 };
 921
 922 /** Control point drag */
 923 class ControlPointDrag : public Drag
 924 {
 925 public:
 926         ControlPointDrag (Editor *, ArdourCanvas::Item *);
 927
 928         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 929         void motion (GdkEvent *, bool);
 930         void finished (GdkEvent *, bool);
 931         void aborted (bool);
 932
 933         bool active (Editing::MouseMode m);
 934
 935 private:
 936
 937         ControlPoint* _point;
 938         double _fixed_grab_x;
 939         double _fixed_grab_y;
 940         double _cumulative_x_drag;
 941         double _cumulative_y_drag;
 942         bool     _pushing;
 943         uint32_t _final_index;
 944         static double _zero_gain_fraction;
 945 };
 946
 947 /** Gain or automation line drag */
 948 class LineDrag : public Drag
 949 {
 950 public:
 951         LineDrag (Editor *e, ArdourCanvas::Item *i);
 952
 953         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 954         void motion (GdkEvent *, bool);
 955         void finished (GdkEvent *, bool);
 956         void aborted (bool);
 957
 958 private:
 959
 960         AutomationLine* _line;
 961         double _fixed_grab_x;
 962         double _fixed_grab_y;
 963         double _cumulative_y_drag;
 964         uint32_t _before;
 965         uint32_t _after;
 966 };
 967
 968 /** Transient feature line drags*/
 969 class FeatureLineDrag : public Drag
 970 {
 971 public:
 972         FeatureLineDrag (Editor *e, ArdourCanvas::Item *i);
 973
 974         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 975         void motion (GdkEvent *, bool);
 976         void finished (GdkEvent *, bool);
 977         void aborted (bool);
 978
 979 private:
 980
 981         ArdourCanvas::Line* _line;
 982         AudioRegionView* _arv;
 983
 984         double _region_view_grab_x;
 985         double _cumulative_x_drag;
 986
 987         float _before;
 988         uint32_t _max_x;
 989 };
 990
 991 /** Dragging of a rubberband rectangle for selecting things */
 992 class RubberbandSelectDrag : public Drag
 993 {
 994 public:
 995         RubberbandSelectDrag (Editor *, ArdourCanvas::Item *);
 996
 997         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 998         void motion (GdkEvent *, bool);
 999         void finished (GdkEvent *, bool);
1000         void aborted (bool);
1001
1002         std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
1003                 return std::make_pair (8, 1);
1004         }
1005
1006         void do_select_things (GdkEvent *, bool);
1007
1008         /** Select some things within a rectangle.
1009          *  @param button_state The button state from the GdkEvent.
1010          *  @param x1 The left-hand side of the rectangle in session frames.
1011          *  @param x2 The right-hand side of the rectangle in session frames.
1012          *  @param y1 The top of the rectangle in trackview coordinates.
1013          *  @param y2 The bottom of the rectangle in trackview coordinates.
1014          *  @param drag_in_progress true if the drag is currently happening.
1015          */
1016         virtual void select_things (int button_state, framepos_t x1, framepos_t x2, double y1, double y2, bool drag_in_progress) = 0;
1017
1018         virtual void deselect_things () = 0;
1019
1020   protected:
1021         bool _vertical_only;
1022 };
1023
1024 /** A general editor RubberbandSelectDrag (for regions, automation points etc.) */
1025 class EditorRubberbandSelectDrag : public RubberbandSelectDrag
1026 {
1027 public:
1028         EditorRubberbandSelectDrag (Editor *, ArdourCanvas::Item *);
1029
1030         void select_things (int, framepos_t, framepos_t, double, double, bool);
1031         void deselect_things ();
1032 };
1033
1034 /** A RubberbandSelectDrag for selecting MIDI notes */
1035 class MidiRubberbandSelectDrag : public RubberbandSelectDrag
1036 {
1037 public:
1038         MidiRubberbandSelectDrag (Editor *, MidiRegionView *);
1039
1040         void select_things (int, framepos_t, framepos_t, double, double, bool);
1041         void deselect_things ();
1042
1043 private:
1044         MidiRegionView* _region_view;
1045 };
1046
1047 /** A RubberbandSelectDrag for selecting MIDI notes but with no horizonal component */
1048 class MidiVerticalSelectDrag : public RubberbandSelectDrag
1049 {
1050 public:
1051         MidiVerticalSelectDrag (Editor *, MidiRegionView *);
1052
1053         void select_things (int, framepos_t, framepos_t, double, double, bool);
1054         void deselect_things ();
1055
1056 private:
1057         MidiRegionView* _region_view;
1058 };
1059
1060 /** Region drag in time-FX mode */
1061 class TimeFXDrag : public RegionDrag
1062 {
1063 public:
1064         TimeFXDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
1065
1066         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1067         void motion (GdkEvent *, bool);
1068         void finished (GdkEvent *, bool);
1069         void aborted (bool);
1070 };
1071
1072 /** Scrub drag in audition mode */
1073 class ScrubDrag : public Drag
1074 {
1075 public:
1076         ScrubDrag (Editor *, ArdourCanvas::Item *);
1077
1078         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1079         void motion (GdkEvent *, bool);
1080         void finished (GdkEvent *, bool);
1081         void aborted (bool);
1082 };
1083
1084 /** Drag in range select mode */
1085 class SelectionDrag : public Drag
1086 {
1087 public:
1088         enum Operation {
1089                 CreateSelection,
1090                 SelectionStartTrim,
1091                 SelectionEndTrim,
1092                 SelectionMove,
1093                 SelectionExtend
1094         };
1095
1096         SelectionDrag (Editor *, ArdourCanvas::Item *, Operation);
1097
1098         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1099         void motion (GdkEvent *, bool);
1100         void finished (GdkEvent *, bool);
1101         void aborted (bool);
1102
1103         void setup_pointer_frame_offset ();
1104
1105 private:
1106         Operation _operation;
1107         bool _add;
1108         std::list<TimeAxisView*> _added_time_axes;
1109         bool _time_selection_at_start;
1110         framepos_t start_at_start;
1111         framepos_t end_at_start;
1112 };
1113
1114 /** Range marker drag */
1115 class RangeMarkerBarDrag : public Drag
1116 {
1117 public:
1118         enum Operation {
1119                 CreateSkipMarker,
1120                 CreateRangeMarker,
1121                 CreateTransportMarker,
1122                 CreateCDMarker
1123         };
1124
1125         RangeMarkerBarDrag (Editor *, ArdourCanvas::Item *, Operation);
1126         ~RangeMarkerBarDrag ();
1127
1128         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1129         void motion (GdkEvent *, bool);
1130         void finished (GdkEvent *, bool);
1131         void aborted (bool);
1132
1133         bool allow_vertical_autoscroll () const {
1134                 return false;
1135         }
1136
1137         bool y_movement_matters () const {
1138                 return false;
1139         }
1140
1141 private:
1142         void update_item (ARDOUR::Location *);
1143
1144         Operation _operation;
1145         ArdourCanvas::Rectangle* _drag_rect;
1146         bool _copy;
1147 };
1148
1149 /** Drag of rectangle to set zoom */
1150 class MouseZoomDrag : public Drag
1151 {
1152 public:
1153         MouseZoomDrag (Editor *, ArdourCanvas::Item *);
1154
1155         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1156         void motion (GdkEvent *, bool);
1157         void finished (GdkEvent *, bool);
1158         void aborted (bool);
1159
1160         std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
1161                 return std::make_pair (4, 4);
1162         }
1163
1164 private:
1165         bool _zoom_out;
1166 };
1167
1168 /** Drag of a range of automation data (either on an automation track or region gain),
1169  *  changing value but not position.
1170  */
1171 class AutomationRangeDrag : public Drag
1172 {
1173 public:
1174         AutomationRangeDrag (Editor *, AutomationTimeAxisView *, std::list<ARDOUR::AudioRange> const &);
1175         AutomationRangeDrag (Editor *, RegionView *, std::list<ARDOUR::AudioRange> const &);
1176
1177         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1178         void motion (GdkEvent *, bool);
1179         void finished (GdkEvent *, bool);
1180         void aborted (bool);
1181
1182         bool x_movement_matters () const {
1183                 return false;
1184         }
1185
1186 private:
1187         void setup (std::list<boost::shared_ptr<AutomationLine> > const &);
1188         double y_fraction (boost::shared_ptr<AutomationLine>, double global_y_position) const;
1189         double value (boost::shared_ptr<ARDOUR::AutomationList> list, double x) const;
1190
1191         std::list<ARDOUR::AudioRange> _ranges;
1192
1193         /** A line that is part of the drag */
1194         struct Line {
1195                 boost::shared_ptr<AutomationLine> line; ///< the line
1196                 std::list<ControlPoint*> points; ///< points to drag on the line
1197                 std::pair<ARDOUR::framepos_t, ARDOUR::framepos_t> range; ///< the range of all points on the line, in session frames
1198                 XMLNode* state; ///< the XML state node before the drag
1199                 double original_fraction; ///< initial y-fraction before the drag
1200         };
1201
1202         std::list<Line> _lines;
1203         double          _y_origin;
1204         bool            _nothing_to_drag;
1205         bool            _integral;
1206 };
1207
1208 /** Drag of one edge of an xfade
1209  */
1210 class CrossfadeEdgeDrag : public Drag
1211 {
1212   public:
1213         CrossfadeEdgeDrag (Editor*, AudioRegionView*, ArdourCanvas::Item*, bool start);
1214
1215         void start_grab (GdkEvent*, Gdk::Cursor* c = 0);
1216         void motion (GdkEvent*, bool);
1217         void finished (GdkEvent*, bool);
1218         void aborted (bool);
1219
1220         bool y_movement_matters () const {
1221                 return false;
1222         }
1223
1224         virtual std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
1225                 return std::make_pair (4, 4);
1226         }
1227
1228   private:
1229         AudioRegionView* arv;
1230         bool start;
1231 };
1232
1233 class RulerZoomDrag : public Drag
1234 {
1235 public:
1236         RulerZoomDrag (Editor*, ArdourCanvas::Item*);
1237
1238         void start_grab (GdkEvent*, Gdk::Cursor* c = 0);
1239         void motion (GdkEvent *, bool);
1240         void finished (GdkEvent*, bool);
1241         void aborted (bool);
1242
1243         virtual bool allow_vertical_autoscroll () const {
1244                 return false;
1245         }
1246
1247 };
1248
1249 #endif /* __gtk2_ardour_editor_drag_h_ */
1250