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