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