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);
 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 };
 286
 287 class RegionDrag;
 288
 289 /** Container for details about a region being dragged */
 290 class DraggingView
 291 {
 292 public:
 293         DraggingView (RegionView *, RegionDrag *, TimeAxisView* original_tav);
 294
 295         RegionView* view; ///< the view
 296         /** index into RegionDrag::_time_axis_views of the view that this region is currently being displayed on,
 297          *  or -1 if it is not visible.
 298          */
 299         int time_axis_view;
 300         /** layer that this region is currently being displayed on.  This is a double
 301             rather than a layer_t as we use fractional layers during drags to allow the user
 302             to indicate a new layer to put a region on.
 303         */
 304         double layer;
 305         double initial_y; ///< the initial y position of the view before any reparenting
 306         framepos_t initial_position; ///< initial position of the region
 307         framepos_t initial_end; ///< initial end position of the region
 308         framepos_t anchored_fade_length; ///< fade_length when anchored during drag
 309         boost::shared_ptr<ARDOUR::Playlist> initial_playlist;
 310         TimeAxisView* initial_time_axis_view;
 311 };
 312
 313 /** Abstract base class for drags that involve region(s) */
 314 class RegionDrag : public Drag, public sigc::trackable
 315 {
 316 public:
 317         RegionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 318         virtual ~RegionDrag () {}
 319
 320 protected:
 321
 322         RegionView* _primary; ///< the view that was clicked on (or whatever) to start the drag
 323         std::list<DraggingView> _views; ///< information about all views that are being dragged
 324
 325         /** a list of the non-hidden TimeAxisViews sorted by editor order key */
 326         std::vector<TimeAxisView*> _time_axis_views;
 327         int find_time_axis_view (TimeAxisView *) const;
 328         int apply_track_delta (const int start, const int delta, const int skip, const bool distance_only = false) const;
 329
 330         int _visible_y_low;
 331         int _visible_y_high;
 332         uint32_t _ntracks;
 333
 334         friend class DraggingView;
 335
 336 private:
 337
 338         void region_going_away (RegionView *);
 339         PBD::ScopedConnection death_connection;
 340 };
 341
 342
 343 /** Drags involving region motion from somewhere */
 344 class RegionMotionDrag : public RegionDrag
 345 {
 346 public:
 347
 348         RegionMotionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool);
 349         virtual ~RegionMotionDrag () {}
 350
 351         virtual void start_grab (GdkEvent *, Gdk::Cursor *);
 352         virtual void motion (GdkEvent *, bool);
 353         virtual void finished (GdkEvent *, bool);
 354         virtual void aborted (bool);
 355
 356         /** @return true if the regions being `moved' came from somewhere on the canvas;
 357          *  false if they came from outside (e.g. from the region list).
 358          */
 359         virtual bool regions_came_from_canvas () const = 0;
 360
 361 protected:
 362
 363         double compute_x_delta (GdkEvent const *, ARDOUR::framepos_t *);
 364         virtual bool y_movement_allowed (int, double, int skip_invisible = 0) const;
 365
 366         bool _brushing;
 367         bool _ignore_video_lock;
 368         ARDOUR::framepos_t _last_frame_position; ///< last position of the thing being dragged
 369         double _total_x_delta;
 370         int _last_pointer_time_axis_view;
 371         double _last_pointer_layer;
 372 private:
 373         uint32_t _ndropzone;
 374         uint32_t _pdropzone;
 375         uint32_t _ddropzone;
 376 };
 377
 378
 379 /** Drags to move (or copy) regions that are already shown in the GUI to
 380  *  somewhere different.
 381  */
 382 class RegionMoveDrag : public RegionMotionDrag
 383 {
 384 public:
 385         RegionMoveDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool, bool);
 386         virtual ~RegionMoveDrag () {}
 387
 388         void motion (GdkEvent *, bool);
 389         void finished (GdkEvent *, bool);
 390         void aborted (bool);
 391
 392         bool regions_came_from_canvas () const {
 393                 return true;
 394         }
 395
 396         std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
 397                 return std::make_pair (4, 4);
 398         }
 399
 400         void setup_pointer_frame_offset ();
 401
 402 protected:
 403         typedef std::set<boost::shared_ptr<ARDOUR::Playlist> > PlaylistSet;
 404         void add_stateful_diff_commands_for_playlists (PlaylistSet const &);
 405
 406 private:
 407         void finished_no_copy (
 408                 bool const,
 409                 bool const,
 410                 ARDOUR::framecnt_t const
 411                 );
 412
 413         void finished_copy (
 414                 bool const,
 415                 bool const,
 416                 ARDOUR::framecnt_t const
 417                 );
 418
 419         RegionView* insert_region_into_playlist (
 420                 boost::shared_ptr<ARDOUR::Region>,
 421                 RouteTimeAxisView*,
 422                 ARDOUR::layer_t,
 423                 ARDOUR::framecnt_t,
 424                 PlaylistSet&
 425                 );
 426
 427         void remove_region_from_playlist (
 428                 boost::shared_ptr<ARDOUR::Region>,
 429                 boost::shared_ptr<ARDOUR::Playlist>,
 430                 PlaylistSet& modified_playlists
 431                 );
 432
 433
 434         void collect_new_region_view (RegionView *);
 435         RouteTimeAxisView* create_destination_time_axis (boost::shared_ptr<ARDOUR::Region>, TimeAxisView* original);
 436
 437         bool _copy;
 438         RegionView* _new_region_view;
 439 };
 440
 441 /** Drag to insert a region from somewhere */
 442 class RegionInsertDrag : public RegionMotionDrag
 443 {
 444 public:
 445         RegionInsertDrag (Editor *, boost::shared_ptr<ARDOUR::Region>, RouteTimeAxisView*, ARDOUR::framepos_t);
 446
 447         void finished (GdkEvent *, bool);
 448         void aborted (bool);
 449
 450         bool regions_came_from_canvas () const {
 451                 return false;
 452         }
 453 };
 454
 455 /** Region drag in splice mode */
 456 class RegionSpliceDrag : public RegionMoveDrag
 457 {
 458 public:
 459         RegionSpliceDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 460
 461         void motion (GdkEvent *, bool);
 462         void finished (GdkEvent *, bool);
 463         void aborted (bool);
 464 };
 465
 466 /** Region drag in ripple mode */
 467
 468 class RegionRippleDrag : public RegionMoveDrag
 469 {
 470 public:
 471         RegionRippleDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 472         ~RegionRippleDrag () { delete exclude; }
 473
 474         void motion (GdkEvent *, bool);
 475         void finished (GdkEvent *, bool);
 476         void aborted (bool);
 477 protected:
 478         bool y_movement_allowed (int delta_track, double delta_layer, int skip_invisible = 0) const;
 479
 480 private:
 481         TimeAxisView *prev_tav;         // where regions were most recently dragged from
 482         TimeAxisView *orig_tav;         // where drag started
 483         ARDOUR::framecnt_t prev_amount;
 484         ARDOUR::framepos_t prev_position;
 485         ARDOUR::framecnt_t selection_length;
 486         bool allow_moves_across_tracks; // only if all selected regions are on one track
 487         ARDOUR::RegionList *exclude;
 488         void add_all_after_to_views (TimeAxisView *tav, ARDOUR::framepos_t where, const RegionSelection &exclude, bool drag_in_progress);
 489         void remove_unselected_from_views (ARDOUR::framecnt_t amount, bool move_regions);
 490
 491 };
 492
 493 /** "Drag" to cut a region (action only on button release) */
 494 class RegionCutDrag : public Drag
 495 {
 496     public:
 497         RegionCutDrag (Editor*, ArdourCanvas::Item*, framepos_t);
 498         ~RegionCutDrag ();
 499
 500         void motion (GdkEvent*, bool);
 501         void finished (GdkEvent*, bool);
 502         void aborted (bool);
 503
 504     private:
 505         EditorCursor* line;
 506 };
 507
 508 /** Drags to create regions */
 509 class RegionCreateDrag : public Drag
 510 {
 511 public:
 512         RegionCreateDrag (Editor *, ArdourCanvas::Item *, TimeAxisView *);
 513
 514         void motion (GdkEvent *, bool);
 515         void finished (GdkEvent *, bool);
 516         void aborted (bool);
 517
 518 private:
 519         MidiTimeAxisView* _view;
 520         boost::shared_ptr<ARDOUR::Region> _region;
 521 };
 522
 523 /** Drags to resize MIDI notes */
 524 class NoteResizeDrag : public Drag
 525 {
 526 public:
 527         NoteResizeDrag (Editor *, ArdourCanvas::Item *);
 528
 529         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 530         void motion (GdkEvent *, bool);
 531         void finished (GdkEvent *, bool);
 532         void aborted (bool);
 533
 534 private:
 535         MidiRegionView*     region;
 536         bool                relative;
 537         bool                at_front;
 538         bool                _was_selected;
 539         double              _snap_delta;
 540 };
 541
 542 /** Drags to move MIDI notes */
 543 class NoteDrag : public Drag
 544 {
 545   public:
 546         NoteDrag (Editor*, ArdourCanvas::Item*);
 547
 548         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 549         void motion (GdkEvent *, bool);
 550         void finished (GdkEvent *, bool);
 551         void aborted (bool);
 552
 553   private:
 554
 555         ARDOUR::frameoffset_t total_dx (const guint) const;
 556         int8_t total_dy () const;
 557
 558         MidiRegionView* _region;
 559         NoteBase* _primary;
 560         double _cumulative_dx;
 561         double _cumulative_dy;
 562         bool   _was_selected;
 563         double _note_height;
 564 };
 565
 566 class NoteCreateDrag : public Drag
 567 {
 568 public:
 569         NoteCreateDrag (Editor *, ArdourCanvas::Item *, MidiRegionView *);
 570         ~NoteCreateDrag ();
 571
 572         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 573         void motion (GdkEvent *, bool);
 574         void finished (GdkEvent *, bool);
 575         void aborted (bool);
 576
 577         bool active (Editing::MouseMode mode) {
 578                 return mode == Editing::MouseDraw || mode == Editing::MouseContent;
 579         }
 580
 581         bool y_movement_matters () const {
 582                 return false;
 583         }
 584
 585 private:
 586         double y_to_region (double) const;
 587         ARDOUR::framecnt_t grid_frames (framepos_t) const;
 588
 589         MidiRegionView* _region_view;
 590         ArdourCanvas::Rectangle* _drag_rect;
 591         framepos_t _note[2];
 592 };
 593
 594 /** Drag to move MIDI patch changes */
 595 class PatchChangeDrag : public Drag
 596 {
 597 public:
 598         PatchChangeDrag (Editor *, PatchChange *, MidiRegionView *);
 599
 600         void motion (GdkEvent *, bool);
 601         void finished (GdkEvent *, bool);
 602         void aborted (bool);
 603
 604         bool y_movement_matters () const {
 605                 return false;
 606         }
 607
 608         void setup_pointer_frame_offset ();
 609
 610 private:
 611         MidiRegionView* _region_view;
 612         PatchChange* _patch_change;
 613         double _cumulative_dx;
 614 };
 615
 616 /** Container for details about audio regions being dragged along with video */
 617 class AVDraggingView
 618 {
 619 public:
 620         AVDraggingView (RegionView *);
 621
 622         RegionView* view; ///< the view
 623         framepos_t initial_position; ///< initial position of the region
 624 };
 625
 626 /** Drag of video offset */
 627 class VideoTimeLineDrag : public Drag
 628 {
 629 public:
 630         VideoTimeLineDrag (Editor *e, ArdourCanvas::Item *i);
 631
 632         void motion (GdkEvent *, bool);
 633         void finished (GdkEvent *, bool);
 634         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 635
 636         bool y_movement_matters () const {
 637                 return false;
 638         }
 639
 640         bool allow_vertical_autoscroll () const {
 641                 return false;
 642         }
 643
 644         void aborted (bool);
 645
 646 protected:
 647         std::list<AVDraggingView> _views; ///< information about all audio that are being dragged along
 648
 649 private:
 650         ARDOUR::frameoffset_t _startdrag_video_offset;
 651         ARDOUR::frameoffset_t _max_backwards_drag;
 652         bool _stuck;
 653 };
 654
 655 /** Drag to trim region(s) */
 656 class TrimDrag : public RegionDrag
 657 {
 658 public:
 659         enum Operation {
 660                 StartTrim,
 661                 EndTrim,
 662                 ContentsTrim,
 663         };
 664
 665         TrimDrag (Editor *, ArdourCanvas::Item *, RegionView*, std::list<RegionView*> const &, bool preserve_fade_anchor = false);
 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 y_movement_matters () const {
 673                 return false;
 674         }
 675
 676         void setup_pointer_frame_offset ();
 677
 678 private:
 679
 680         Operation _operation;
 681
 682         bool _preserve_fade_anchor;
 683         bool _jump_position_when_done;
 684 };
 685
 686 /** Meter marker drag */
 687 class MeterMarkerDrag : public Drag
 688 {
 689 public:
 690         MeterMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
 691
 692         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 693         void motion (GdkEvent *, bool);
 694         void finished (GdkEvent *, bool);
 695         void aborted (bool);
 696
 697         bool allow_vertical_autoscroll () const {
 698                 return false;
 699         }
 700
 701         bool y_movement_matters () const {
 702                 return false;
 703         }
 704
 705         void setup_pointer_frame_offset ();
 706
 707 private:
 708         MeterMarker* _marker;
 709         ARDOUR::MeterSection* _real_section;
 710
 711         bool _copy;
 712         XMLNode* before_state;
 713 };
 714
 715 /** Tempo marker drag */
 716 class TempoMarkerDrag : public Drag
 717 {
 718 public:
 719         TempoMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
 720
 721         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 722         void motion (GdkEvent *, bool);
 723         void finished (GdkEvent *, bool);
 724         void aborted (bool);
 725
 726         bool allow_vertical_autoscroll () const {
 727                 return false;
 728         }
 729
 730         bool y_movement_matters () const {
 731                 return true;
 732         }
 733
 734         void setup_pointer_frame_offset ();
 735
 736 private:
 737         TempoMarker* _marker;
 738         ARDOUR::TempoSection* _real_section;
 739
 740         bool _copy;
 741         bool _movable;
 742         XMLNode* before_state;
 743 };
 744
 745 /** BBT Ruler drag */
 746 class BBTRulerDrag : public Drag
 747 {
 748 public:
 749         BBTRulerDrag (Editor *, ArdourCanvas::Item *);
 750
 751         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 752         void motion (GdkEvent *, bool);
 753         void finished (GdkEvent *, bool);
 754         void aborted (bool);
 755
 756         bool allow_vertical_autoscroll () const {
 757                 return false;
 758         }
 759
 760         bool y_movement_matters () const {
 761                 return false;
 762         }
 763
 764         void setup_pointer_frame_offset ();
 765
 766 private:
 767         double _pulse;
 768         double _beat;
 769         ARDOUR::TempoSection* _tempo;
 770         XMLNode* before_state;
 771 };
 772
 773 /** Drag of the playhead cursor */
 774 class CursorDrag : public Drag
 775 {
 776 public:
 777         CursorDrag (Editor *, EditorCursor&, bool);
 778
 779         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 780         void motion (GdkEvent *, bool);
 781         void finished (GdkEvent *, bool);
 782         void aborted (bool);
 783
 784         bool allow_vertical_autoscroll () const {
 785                 return false;
 786         }
 787
 788         bool y_movement_matters () const {
 789                 return true;
 790         }
 791
 792 private:
 793         void fake_locate (framepos_t);
 794
 795         EditorCursor& _cursor;
 796         bool _stop; ///< true to stop the transport on starting the drag, otherwise false
 797         double _grab_zoom; ///< editor frames per unit when our grab started
 798 };
 799
 800 /** Region fade-in drag */
 801 class FadeInDrag : public RegionDrag
 802 {
 803 public:
 804         FadeInDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 805
 806         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 807         void motion (GdkEvent *, bool);
 808         void finished (GdkEvent *, bool);
 809         void aborted (bool);
 810
 811         bool y_movement_matters () const {
 812                 return false;
 813         }
 814
 815         void setup_pointer_frame_offset ();
 816 };
 817
 818 /** Region fade-out drag */
 819 class FadeOutDrag : public RegionDrag
 820 {
 821 public:
 822         FadeOutDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 823
 824         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 825         void motion (GdkEvent *, bool);
 826         void finished (GdkEvent *, bool);
 827         void aborted (bool);
 828
 829         bool y_movement_matters () const {
 830                 return false;
 831         }
 832
 833         void setup_pointer_frame_offset ();
 834 };
 835
 836 /** Marker drag */
 837 class MarkerDrag : public Drag
 838 {
 839 public:
 840         MarkerDrag (Editor *, ArdourCanvas::Item *);
 841         ~MarkerDrag ();
 842
 843         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 844         void motion (GdkEvent *, bool);
 845         void finished (GdkEvent *, bool);
 846         void aborted (bool);
 847
 848         bool allow_vertical_autoscroll () const {
 849                 return false;
 850         }
 851
 852         bool y_movement_matters () const {
 853                 return false;
 854         }
 855
 856         void setup_pointer_frame_offset ();
 857
 858 private:
 859         void update_item (ARDOUR::Location *);
 860
 861         ArdourMarker* _marker; ///< marker being dragged
 862         bool _selection_changed;
 863         struct CopiedLocationMarkerInfo {
 864             ARDOUR::Location* location;
 865             std::vector<ArdourMarker*> markers;
 866             bool    move_both;
 867             CopiedLocationMarkerInfo (ARDOUR::Location* l, ArdourMarker* m);
 868         };
 869
 870         typedef std::list<CopiedLocationMarkerInfo> CopiedLocationInfo;
 871         CopiedLocationInfo _copied_locations;
 872         ArdourCanvas::Points _points;
 873 };
 874
 875 /** Control point drag */
 876 class ControlPointDrag : public Drag
 877 {
 878 public:
 879         ControlPointDrag (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         bool active (Editing::MouseMode m);
 887
 888 private:
 889
 890         ControlPoint* _point;
 891         double _fixed_grab_x;
 892         double _fixed_grab_y;
 893         double _cumulative_x_drag;
 894         double _cumulative_y_drag;
 895         bool     _pushing;
 896         uint32_t _final_index;
 897         static double _zero_gain_fraction;
 898 };
 899
 900 /** Gain or automation line drag */
 901 class LineDrag : public Drag
 902 {
 903 public:
 904         LineDrag (Editor *e, ArdourCanvas::Item *i);
 905
 906         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 907         void motion (GdkEvent *, bool);
 908         void finished (GdkEvent *, bool);
 909         void aborted (bool);
 910
 911 private:
 912
 913         AutomationLine* _line;
 914         double _fixed_grab_x;
 915         double _fixed_grab_y;
 916         double _cumulative_y_drag;
 917         uint32_t _before;
 918         uint32_t _after;
 919 };
 920
 921 /** Transient feature line drags*/
 922 class FeatureLineDrag : public Drag
 923 {
 924 public:
 925         FeatureLineDrag (Editor *e, ArdourCanvas::Item *i);
 926
 927         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 928         void motion (GdkEvent *, bool);
 929         void finished (GdkEvent *, bool);
 930         void aborted (bool);
 931
 932 private:
 933
 934         ArdourCanvas::Line* _line;
 935         AudioRegionView* _arv;
 936
 937         double _region_view_grab_x;
 938         double _cumulative_x_drag;
 939
 940         float _before;
 941         uint32_t _max_x;
 942 };
 943
 944 /** Dragging of a rubberband rectangle for selecting things */
 945 class RubberbandSelectDrag : public Drag
 946 {
 947 public:
 948         RubberbandSelectDrag (Editor *, ArdourCanvas::Item *);
 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         std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
 956                 return std::make_pair (8, 1);
 957         }
 958
 959         void do_select_things (GdkEvent *, bool);
 960
 961         /** Select some things within a rectangle.
 962          *  @param button_state The button state from the GdkEvent.
 963          *  @param x1 The left-hand side of the rectangle in session frames.
 964          *  @param x2 The right-hand side of the rectangle in session frames.
 965          *  @param y1 The top of the rectangle in trackview coordinates.
 966          *  @param y2 The bottom of the rectangle in trackview coordinates.
 967          *  @param drag_in_progress true if the drag is currently happening.
 968          */
 969         virtual void select_things (int button_state, framepos_t x1, framepos_t x2, double y1, double y2, bool drag_in_progress) = 0;
 970
 971         virtual void deselect_things () = 0;
 972
 973   protected:
 974         bool _vertical_only;
 975 };
 976
 977 /** A general editor RubberbandSelectDrag (for regions, automation points etc.) */
 978 class EditorRubberbandSelectDrag : public RubberbandSelectDrag
 979 {
 980 public:
 981         EditorRubberbandSelectDrag (Editor *, ArdourCanvas::Item *);
 982
 983         void select_things (int, framepos_t, framepos_t, double, double, bool);
 984         void deselect_things ();
 985 };
 986
 987 /** A RubberbandSelectDrag for selecting MIDI notes */
 988 class MidiRubberbandSelectDrag : public RubberbandSelectDrag
 989 {
 990 public:
 991         MidiRubberbandSelectDrag (Editor *, MidiRegionView *);
 992
 993         void select_things (int, framepos_t, framepos_t, double, double, bool);
 994         void deselect_things ();
 995
 996 private:
 997         MidiRegionView* _region_view;
 998 };
 999
1000 /** A RubberbandSelectDrag for selecting MIDI notes but with no horizonal component */
1001 class MidiVerticalSelectDrag : public RubberbandSelectDrag
1002 {
1003 public:
1004         MidiVerticalSelectDrag (Editor *, MidiRegionView *);
1005
1006         void select_things (int, framepos_t, framepos_t, double, double, bool);
1007         void deselect_things ();
1008
1009 private:
1010         MidiRegionView* _region_view;
1011 };
1012
1013 /** Region drag in time-FX mode */
1014 class TimeFXDrag : public RegionDrag
1015 {
1016 public:
1017         TimeFXDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
1018
1019         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1020         void motion (GdkEvent *, bool);
1021         void finished (GdkEvent *, bool);
1022         void aborted (bool);
1023 };
1024
1025 /** Scrub drag in audition mode */
1026 class ScrubDrag : public Drag
1027 {
1028 public:
1029         ScrubDrag (Editor *, ArdourCanvas::Item *);
1030
1031         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1032         void motion (GdkEvent *, bool);
1033         void finished (GdkEvent *, bool);
1034         void aborted (bool);
1035 };
1036
1037 /** Drag in range select mode */
1038 class SelectionDrag : public Drag
1039 {
1040 public:
1041         enum Operation {
1042                 CreateSelection,
1043                 SelectionStartTrim,
1044                 SelectionEndTrim,
1045                 SelectionMove,
1046                 SelectionExtend
1047         };
1048
1049         SelectionDrag (Editor *, ArdourCanvas::Item *, Operation);
1050
1051         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1052         void motion (GdkEvent *, bool);
1053         void finished (GdkEvent *, bool);
1054         void aborted (bool);
1055
1056         void setup_pointer_frame_offset ();
1057
1058 private:
1059         Operation _operation;
1060         bool _add;
1061         std::list<TimeAxisView*> _added_time_axes;
1062         bool _time_selection_at_start;
1063         framepos_t start_at_start;
1064         framepos_t end_at_start;
1065 };
1066
1067 /** Range marker drag */
1068 class RangeMarkerBarDrag : public Drag
1069 {
1070 public:
1071         enum Operation {
1072                 CreateSkipMarker,
1073                 CreateRangeMarker,
1074                 CreateTransportMarker,
1075                 CreateCDMarker
1076         };
1077
1078         RangeMarkerBarDrag (Editor *, ArdourCanvas::Item *, Operation);
1079         ~RangeMarkerBarDrag ();
1080
1081         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1082         void motion (GdkEvent *, bool);
1083         void finished (GdkEvent *, bool);
1084         void aborted (bool);
1085
1086         bool allow_vertical_autoscroll () const {
1087                 return false;
1088         }
1089
1090         bool y_movement_matters () const {
1091                 return false;
1092         }
1093
1094 private:
1095         void update_item (ARDOUR::Location *);
1096
1097         Operation _operation;
1098         ArdourCanvas::Rectangle* _drag_rect;
1099         bool _copy;
1100 };
1101
1102 /** Drag of rectangle to set zoom */
1103 class MouseZoomDrag : public Drag
1104 {
1105 public:
1106         MouseZoomDrag (Editor *, ArdourCanvas::Item *);
1107
1108         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1109         void motion (GdkEvent *, bool);
1110         void finished (GdkEvent *, bool);
1111         void aborted (bool);
1112
1113         std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
1114                 return std::make_pair (4, 4);
1115         }
1116
1117 private:
1118         bool _zoom_out;
1119 };
1120
1121 /** Drag of a range of automation data (either on an automation track or region gain),
1122  *  changing value but not position.
1123  */
1124 class AutomationRangeDrag : public Drag
1125 {
1126 public:
1127         AutomationRangeDrag (Editor *, AutomationTimeAxisView *, std::list<ARDOUR::AudioRange> const &);
1128         AutomationRangeDrag (Editor *, RegionView *, std::list<ARDOUR::AudioRange> const &);
1129
1130         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1131         void motion (GdkEvent *, bool);
1132         void finished (GdkEvent *, bool);
1133         void aborted (bool);
1134
1135         bool x_movement_matters () const {
1136                 return false;
1137         }
1138
1139 private:
1140         void setup (std::list<boost::shared_ptr<AutomationLine> > const &);
1141         double y_fraction (boost::shared_ptr<AutomationLine>, double global_y_position) const;
1142         double value (boost::shared_ptr<ARDOUR::AutomationList> list, double x) const;
1143
1144         std::list<ARDOUR::AudioRange> _ranges;
1145
1146         /** A line that is part of the drag */
1147         struct Line {
1148                 boost::shared_ptr<AutomationLine> line; ///< the line
1149                 std::list<ControlPoint*> points; ///< points to drag on the line
1150                 std::pair<ARDOUR::framepos_t, ARDOUR::framepos_t> range; ///< the range of all points on the line, in session frames
1151                 XMLNode* state; ///< the XML state node before the drag
1152                 double original_fraction; ///< initial y-fraction before the drag
1153         };
1154
1155         std::list<Line> _lines;
1156         double          _y_origin;
1157         bool            _nothing_to_drag;
1158         bool            _integral;
1159 };
1160
1161 /** Drag of one edge of an xfade
1162  */
1163 class CrossfadeEdgeDrag : public Drag
1164 {
1165   public:
1166         CrossfadeEdgeDrag (Editor*, AudioRegionView*, ArdourCanvas::Item*, bool start);
1167
1168         void start_grab (GdkEvent*, Gdk::Cursor* c = 0);
1169         void motion (GdkEvent*, bool);
1170         void finished (GdkEvent*, bool);
1171         void aborted (bool);
1172
1173         bool y_movement_matters () const {
1174                 return false;
1175         }
1176
1177         virtual std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
1178                 return std::make_pair (4, 4);
1179         }
1180
1181   private:
1182         AudioRegionView* arv;
1183         bool start;
1184 };
1185
1186 #endif /* __gtk2_ardour_editor_drag_h_ */
1187