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