PBD::Signal<...>::connect() is already thread safe, so drop intermediate proxy/call_s...
[ardour.git] / 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 frame */
113         ARDOUR::framepos_t current_pointer_frame () const {
114                 return _current_pointer_frame;
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::framepos_t _current_pointer_frame; ///< frame 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::MusicFrame adjusted_frame (ARDOUR::framepos_t, GdkEvent const *, bool snap = true) const;
148         ARDOUR::framepos_t adjusted_current_frame (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 frames (in x) and pixels (in y) that should be considered a movement */
187         virtual std::pair<ARDOUR::framecnt_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_frame_offset */
210         virtual void setup_pointer_frame_offset () {
211                 _pointer_frame_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::framepos_t raw_grab_frame () const {
225                 return _raw_grab_frame;
226         }
227
228         ARDOUR::framepos_t grab_frame () const {
229                 return _grab_frame;
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::framepos_t last_pointer_frame () const {
241                 return _last_pointer_frame;
242         }
243
244         ARDOUR::frameoffset_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::MusicFrame pos);
252
253         boost::shared_ptr<ARDOUR::Region> add_midi_region (MidiTimeAxisView*, bool commit);
254
255         void show_verbose_cursor_time (framepos_t);
256         void show_verbose_cursor_duration (framepos_t, framepos_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::framecnt_t _pointer_frame_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::framepos_t _raw_grab_frame; ///< unsnapped frame that the mouse was at when start_grab was called, or 0
279         ARDOUR::framepos_t _grab_frame; ///< adjusted_frame that the mouse was at when start_grab was called, or 0
280         ARDOUR::framepos_t _last_pointer_frame; ///< adjusted_frame the last time a motion occurred
281
282         /* difference between some key position's snapped and unsnapped
283          *  framepos. used for relative snap.
284          */
285         framepos_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         framepos_t initial_position; ///< initial position of the region
311         framepos_t initial_end; ///< initial end position of the region
312         framepos_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::MusicFrame *);
368         virtual bool y_movement_allowed (int, double, int skip_invisible = 0) const;
369
370         bool _brushing;
371         bool _ignore_video_lock;
372         ARDOUR::MusicFrame _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::framecnt_t, int> move_threshold () const {
401                 return std::make_pair (4, 4);
402         }
403
404         void setup_pointer_frame_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::MusicFrame,
415                 int32_t const ev_state
416                 );
417
418         void finished_copy (
419                 bool const,
420                 bool const,
421                 ARDOUR::MusicFrame,
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::MusicFrame,
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::framepos_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::framecnt_t prev_amount;
492         ARDOUR::framepos_t prev_position;
493         ARDOUR::framecnt_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::framepos_t where, const RegionSelection &exclude, bool drag_in_progress);
497         void remove_unselected_from_views (ARDOUR::framecnt_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*, framepos_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         EditorCursor* line;
515 };
516
517 /** Drags to create regions */
518 class RegionCreateDrag : public Drag
519 {
520 public:
521         RegionCreateDrag (Editor *, ArdourCanvas::Item *, TimeAxisView *);
522
523         void motion (GdkEvent *, bool);
524         void finished (GdkEvent *, bool);
525         void aborted (bool);
526
527 private:
528         MidiTimeAxisView* _view;
529         boost::shared_ptr<ARDOUR::Region> _region;
530 };
531
532 /** Drags to resize MIDI notes */
533 class NoteResizeDrag : public Drag
534 {
535 public:
536         NoteResizeDrag (Editor *, ArdourCanvas::Item *);
537
538         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
539         void motion (GdkEvent *, bool);
540         void finished (GdkEvent *, bool);
541         void aborted (bool);
542
543 private:
544         MidiRegionView*     region;
545         bool                relative;
546         bool                at_front;
547         bool                _was_selected;
548         double              _snap_delta;
549 };
550
551 /** Drags to move MIDI notes */
552 class NoteDrag : public Drag
553 {
554   public:
555         NoteDrag (Editor*, ArdourCanvas::Item*);
556
557         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
558         void motion (GdkEvent *, bool);
559         void finished (GdkEvent *, bool);
560         void aborted (bool);
561
562         void setup_pointer_frame_offset ();
563   private:
564
565         double total_dx (GdkEvent * event) const; // total movement in quarter notes
566         int8_t total_dy () const;
567
568         MidiRegionView* _region;
569         NoteBase* _primary;
570         double _cumulative_dx;
571         double _cumulative_dy;
572         double _earliest; // earliest quarter note in note selection
573         bool   _was_selected;
574         double _note_height;
575         bool   _copy;
576 };
577
578 class NoteCreateDrag : public Drag
579 {
580 public:
581         NoteCreateDrag (Editor *, ArdourCanvas::Item *, MidiRegionView *);
582         ~NoteCreateDrag ();
583
584         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
585         void motion (GdkEvent *, bool);
586         void finished (GdkEvent *, bool);
587         void aborted (bool);
588
589         bool active (Editing::MouseMode mode) {
590                 return mode == Editing::MouseDraw || mode == Editing::MouseContent;
591         }
592
593         bool y_movement_matters () const {
594                 return false;
595         }
596
597 private:
598         double y_to_region (double) const;
599         ARDOUR::framecnt_t grid_frames (framepos_t) const;
600
601         /** @return minimum number of frames (in x) and pixels (in y) that should be considered a movement */
602         virtual std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
603                 return std::make_pair (0, 0);
604         }
605
606         MidiRegionView* _region_view;
607         ArdourCanvas::Rectangle* _drag_rect;
608         framepos_t _note[2];
609 };
610
611 class HitCreateDrag : public Drag
612 {
613 public:
614         HitCreateDrag (Editor *, ArdourCanvas::Item *, MidiRegionView *);
615         ~HitCreateDrag ();
616
617         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
618         void motion (GdkEvent *, bool);
619         void finished (GdkEvent *, bool);
620         void aborted (bool);
621
622         bool active (Editing::MouseMode mode) {
623                 return mode == Editing::MouseDraw || mode == Editing::MouseContent;
624         }
625
626         bool y_movement_matters () const {
627                 return false;
628         }
629
630 private:
631         double y_to_region (double) const;
632         ARDOUR::framecnt_t grid_frames (framepos_t) const;
633
634         /** @return minimum number of frames (in x) and pixels (in y) that should be considered a movement */
635         virtual std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
636                 return std::make_pair (0, 0);
637         }
638
639         MidiRegionView* _region_view;
640         framepos_t      _last_pos;
641         double          _last_y;
642
643 };
644
645 /** Drag to move MIDI patch changes */
646 class PatchChangeDrag : public Drag
647 {
648 public:
649         PatchChangeDrag (Editor *, PatchChange *, MidiRegionView *);
650
651         void motion (GdkEvent *, bool);
652         void finished (GdkEvent *, bool);
653         void aborted (bool);
654
655         bool y_movement_matters () const {
656                 return false;
657         }
658
659         void setup_pointer_frame_offset ();
660
661 private:
662         MidiRegionView* _region_view;
663         PatchChange* _patch_change;
664         double _cumulative_dx;
665 };
666
667 /** Container for details about audio regions being dragged along with video */
668 class AVDraggingView
669 {
670 public:
671         AVDraggingView (RegionView *);
672
673         RegionView* view; ///< the view
674         framepos_t initial_position; ///< initial position of the region
675 };
676
677 /** Drag of video offset */
678 class VideoTimeLineDrag : public Drag
679 {
680 public:
681         VideoTimeLineDrag (Editor *e, ArdourCanvas::Item *i);
682
683         void motion (GdkEvent *, bool);
684         void finished (GdkEvent *, bool);
685         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
686
687         bool y_movement_matters () const {
688                 return false;
689         }
690
691         bool allow_vertical_autoscroll () const {
692                 return false;
693         }
694
695         void aborted (bool);
696
697 protected:
698         std::list<AVDraggingView> _views; ///< information about all audio that are being dragged along
699
700 private:
701         ARDOUR::frameoffset_t _startdrag_video_offset;
702         ARDOUR::frameoffset_t _max_backwards_drag;
703         bool _stuck;
704 };
705
706 /** Drag to trim region(s) */
707 class TrimDrag : public RegionDrag
708 {
709 public:
710         enum Operation {
711                 StartTrim,
712                 EndTrim,
713                 ContentsTrim,
714         };
715
716         TrimDrag (Editor *, ArdourCanvas::Item *, RegionView*, std::list<RegionView*> const &, bool preserve_fade_anchor = false);
717
718         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
719         void motion (GdkEvent *, bool);
720         void finished (GdkEvent *, bool);
721         void aborted (bool);
722
723         bool y_movement_matters () const {
724                 return false;
725         }
726
727         void setup_pointer_frame_offset ();
728
729 private:
730
731         Operation _operation;
732
733         bool _preserve_fade_anchor;
734         bool _jump_position_when_done;
735 };
736
737 /** Meter marker drag */
738 class MeterMarkerDrag : public Drag
739 {
740 public:
741         MeterMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
742
743         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
744         void motion (GdkEvent *, bool);
745         void finished (GdkEvent *, bool);
746         void aborted (bool);
747
748         bool allow_vertical_autoscroll () const {
749                 return false;
750         }
751
752         bool y_movement_matters () const {
753                 return false;
754         }
755
756         void setup_pointer_frame_offset ();
757
758 private:
759         MeterMarker* _marker;
760         ARDOUR::MeterSection* _real_section;
761
762         bool _copy;
763         Editing::SnapType _old_snap_type;
764         Editing::SnapMode _old_snap_mode;
765         XMLNode* before_state;
766 };
767
768 /** Tempo marker drag */
769 class TempoMarkerDrag : public Drag
770 {
771 public:
772         TempoMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
773
774         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
775         void motion (GdkEvent *, bool);
776         void finished (GdkEvent *, bool);
777         void aborted (bool);
778
779         bool allow_vertical_autoscroll () const {
780                 return false;
781         }
782
783         bool y_movement_matters () const {
784                 return true;
785         }
786
787         void setup_pointer_frame_offset ();
788
789 private:
790         TempoMarker* _marker;
791         ARDOUR::TempoSection* _real_section;
792
793         bool _copy;
794         bool _movable;
795         double _grab_bpm;
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_frame_offset ();
819
820 private:
821         double _grab_qn;
822         ARDOUR::TempoSection* _tempo;
823         XMLNode* before_state;
824 };
825
826 /** Drag of the playhead cursor */
827 class CursorDrag : public Drag
828 {
829 public:
830         CursorDrag (Editor *, EditorCursor&, bool);
831
832         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
833         void motion (GdkEvent *, bool);
834         void finished (GdkEvent *, bool);
835         void aborted (bool);
836
837         bool allow_vertical_autoscroll () const {
838                 return false;
839         }
840
841         bool y_movement_matters () const {
842                 return true;
843         }
844
845 private:
846         void fake_locate (framepos_t);
847
848         EditorCursor& _cursor;
849         bool _stop; ///< true to stop the transport on starting the drag, otherwise false
850         double _grab_zoom; ///< editor frames per unit when our grab started
851 };
852
853 /** Region fade-in drag */
854 class FadeInDrag : public RegionDrag
855 {
856 public:
857         FadeInDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
858
859         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
860         void motion (GdkEvent *, bool);
861         void finished (GdkEvent *, bool);
862         void aborted (bool);
863
864         bool y_movement_matters () const {
865                 return false;
866         }
867
868         void setup_pointer_frame_offset ();
869 };
870
871 /** Region fade-out drag */
872 class FadeOutDrag : public RegionDrag
873 {
874 public:
875         FadeOutDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
876
877         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
878         void motion (GdkEvent *, bool);
879         void finished (GdkEvent *, bool);
880         void aborted (bool);
881
882         bool y_movement_matters () const {
883                 return false;
884         }
885
886         void setup_pointer_frame_offset ();
887 };
888
889 /** Marker drag */
890 class MarkerDrag : public Drag
891 {
892 public:
893         MarkerDrag (Editor *, ArdourCanvas::Item *);
894         ~MarkerDrag ();
895
896         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
897         void motion (GdkEvent *, bool);
898         void finished (GdkEvent *, bool);
899         void aborted (bool);
900
901         bool allow_vertical_autoscroll () const {
902                 return false;
903         }
904
905         bool y_movement_matters () const {
906                 return false;
907         }
908
909         void setup_pointer_frame_offset ();
910
911 private:
912         void update_item (ARDOUR::Location *);
913
914         ArdourMarker* _marker; ///< marker being dragged
915         bool _selection_changed;
916         struct CopiedLocationMarkerInfo {
917             ARDOUR::Location* location;
918             std::vector<ArdourMarker*> markers;
919             bool    move_both;
920             CopiedLocationMarkerInfo (ARDOUR::Location* l, ArdourMarker* m);
921         };
922
923         typedef std::list<CopiedLocationMarkerInfo> CopiedLocationInfo;
924         CopiedLocationInfo _copied_locations;
925         ArdourCanvas::Points _points;
926 };
927
928 /** Control point drag */
929 class ControlPointDrag : public Drag
930 {
931 public:
932         ControlPointDrag (Editor *, ArdourCanvas::Item *);
933
934         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
935         void motion (GdkEvent *, bool);
936         void finished (GdkEvent *, bool);
937         void aborted (bool);
938
939         bool active (Editing::MouseMode m);
940
941 private:
942
943         ControlPoint* _point;
944         double _fixed_grab_x;
945         double _fixed_grab_y;
946         double _cumulative_x_drag;
947         double _cumulative_y_drag;
948         bool     _pushing;
949         uint32_t _final_index;
950         static double _zero_gain_fraction;
951 };
952
953 /** Gain or automation line drag */
954 class LineDrag : public Drag
955 {
956 public:
957         LineDrag (Editor *e, ArdourCanvas::Item *i);
958
959         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
960         void motion (GdkEvent *, bool);
961         void finished (GdkEvent *, bool);
962         void aborted (bool);
963
964 private:
965
966         AutomationLine* _line;
967         double _fixed_grab_x;
968         double _fixed_grab_y;
969         double _cumulative_y_drag;
970         uint32_t _before;
971         uint32_t _after;
972 };
973
974 /** Transient feature line drags*/
975 class FeatureLineDrag : public Drag
976 {
977 public:
978         FeatureLineDrag (Editor *e, ArdourCanvas::Item *i);
979
980         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
981         void motion (GdkEvent *, bool);
982         void finished (GdkEvent *, bool);
983         void aborted (bool);
984
985 private:
986
987         ArdourCanvas::Line* _line;
988         AudioRegionView* _arv;
989
990         double _region_view_grab_x;
991         double _cumulative_x_drag;
992
993         float _before;
994         uint32_t _max_x;
995 };
996
997 /** Dragging of a rubberband rectangle for selecting things */
998 class RubberbandSelectDrag : public Drag
999 {
1000 public:
1001         RubberbandSelectDrag (Editor *, ArdourCanvas::Item *);
1002
1003         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1004         void motion (GdkEvent *, bool);
1005         void finished (GdkEvent *, bool);
1006         void aborted (bool);
1007
1008         std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
1009                 return std::make_pair (8, 1);
1010         }
1011
1012         void do_select_things (GdkEvent *, bool);
1013
1014         /** Select some things within a rectangle.
1015          *  @param button_state The button state from the GdkEvent.
1016          *  @param x1 The left-hand side of the rectangle in session frames.
1017          *  @param x2 The right-hand side of the rectangle in session frames.
1018          *  @param y1 The top of the rectangle in trackview coordinates.
1019          *  @param y2 The bottom of the rectangle in trackview coordinates.
1020          *  @param drag_in_progress true if the drag is currently happening.
1021          */
1022         virtual void select_things (int button_state, framepos_t x1, framepos_t x2, double y1, double y2, bool drag_in_progress) = 0;
1023
1024         virtual void deselect_things () = 0;
1025
1026   protected:
1027         bool _vertical_only;
1028 };
1029
1030 /** A general editor RubberbandSelectDrag (for regions, automation points etc.) */
1031 class EditorRubberbandSelectDrag : public RubberbandSelectDrag
1032 {
1033 public:
1034         EditorRubberbandSelectDrag (Editor *, ArdourCanvas::Item *);
1035
1036         void select_things (int, framepos_t, framepos_t, double, double, bool);
1037         void deselect_things ();
1038 };
1039
1040 /** A RubberbandSelectDrag for selecting MIDI notes */
1041 class MidiRubberbandSelectDrag : public RubberbandSelectDrag
1042 {
1043 public:
1044         MidiRubberbandSelectDrag (Editor *, MidiRegionView *);
1045
1046         void select_things (int, framepos_t, framepos_t, double, double, bool);
1047         void deselect_things ();
1048
1049 private:
1050         MidiRegionView* _region_view;
1051 };
1052
1053 /** A RubberbandSelectDrag for selecting MIDI notes but with no horizonal component */
1054 class MidiVerticalSelectDrag : public RubberbandSelectDrag
1055 {
1056 public:
1057         MidiVerticalSelectDrag (Editor *, MidiRegionView *);
1058
1059         void select_things (int, framepos_t, framepos_t, double, double, bool);
1060         void deselect_things ();
1061
1062 private:
1063         MidiRegionView* _region_view;
1064 };
1065
1066 /** Region drag in time-FX mode */
1067 class TimeFXDrag : public RegionDrag
1068 {
1069 public:
1070         TimeFXDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
1071
1072         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1073         void motion (GdkEvent *, bool);
1074         void finished (GdkEvent *, bool);
1075         void aborted (bool);
1076 };
1077
1078 /** Scrub drag in audition mode */
1079 class ScrubDrag : public Drag
1080 {
1081 public:
1082         ScrubDrag (Editor *, ArdourCanvas::Item *);
1083
1084         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1085         void motion (GdkEvent *, bool);
1086         void finished (GdkEvent *, bool);
1087         void aborted (bool);
1088 };
1089
1090 /** Drag in range select mode */
1091 class SelectionDrag : public Drag
1092 {
1093 public:
1094         enum Operation {
1095                 CreateSelection,
1096                 SelectionStartTrim,
1097                 SelectionEndTrim,
1098                 SelectionMove,
1099                 SelectionExtend
1100         };
1101
1102         SelectionDrag (Editor *, ArdourCanvas::Item *, Operation);
1103
1104         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1105         void motion (GdkEvent *, bool);
1106         void finished (GdkEvent *, bool);
1107         void aborted (bool);
1108
1109         void setup_pointer_frame_offset ();
1110
1111 private:
1112         Operation _operation;
1113         bool _add;
1114         TrackSelection _track_selection_at_start;
1115         bool _time_selection_at_start;
1116         framepos_t start_at_start;
1117         framepos_t end_at_start;
1118 };
1119
1120 /** Range marker drag */
1121 class RangeMarkerBarDrag : public Drag
1122 {
1123 public:
1124         enum Operation {
1125                 CreateSkipMarker,
1126                 CreateRangeMarker,
1127                 CreateTransportMarker,
1128                 CreateCDMarker
1129         };
1130
1131         RangeMarkerBarDrag (Editor *, ArdourCanvas::Item *, Operation);
1132         ~RangeMarkerBarDrag ();
1133
1134         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1135         void motion (GdkEvent *, bool);
1136         void finished (GdkEvent *, bool);
1137         void aborted (bool);
1138
1139         bool allow_vertical_autoscroll () const {
1140                 return false;
1141         }
1142
1143         bool y_movement_matters () const {
1144                 return false;
1145         }
1146
1147 private:
1148         void update_item (ARDOUR::Location *);
1149
1150         Operation _operation;
1151         ArdourCanvas::Rectangle* _drag_rect;
1152         bool _copy;
1153 };
1154
1155 /** Drag of rectangle to set zoom */
1156 class MouseZoomDrag : public Drag
1157 {
1158 public:
1159         MouseZoomDrag (Editor *, ArdourCanvas::Item *);
1160
1161         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1162         void motion (GdkEvent *, bool);
1163         void finished (GdkEvent *, bool);
1164         void aborted (bool);
1165
1166         std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
1167                 return std::make_pair (4, 4);
1168         }
1169
1170 private:
1171         bool _zoom_out;
1172 };
1173
1174 /** Drag of a range of automation data (either on an automation track or region gain),
1175  *  changing value but not position.
1176  */
1177 class AutomationRangeDrag : public Drag
1178 {
1179 public:
1180         AutomationRangeDrag (Editor *, AutomationTimeAxisView *, std::list<ARDOUR::AudioRange> const &);
1181         AutomationRangeDrag (Editor *, RegionView *, std::list<ARDOUR::AudioRange> const &);
1182
1183         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
1184         void motion (GdkEvent *, bool);
1185         void finished (GdkEvent *, bool);
1186         void aborted (bool);
1187
1188         bool x_movement_matters () const {
1189                 return false;
1190         }
1191
1192 private:
1193         void setup (std::list<boost::shared_ptr<AutomationLine> > const &);
1194         double y_fraction (boost::shared_ptr<AutomationLine>, double global_y_position) const;
1195         double value (boost::shared_ptr<ARDOUR::AutomationList> list, double x) const;
1196
1197         std::list<ARDOUR::AudioRange> _ranges;
1198
1199         /** A line that is part of the drag */
1200         struct Line {
1201                 boost::shared_ptr<AutomationLine> line; ///< the line
1202                 std::list<ControlPoint*> points; ///< points to drag on the line
1203                 std::pair<ARDOUR::framepos_t, ARDOUR::framepos_t> range; ///< the range of all points on the line, in session frames
1204                 XMLNode* state; ///< the XML state node before the drag
1205                 double original_fraction; ///< initial y-fraction before the drag
1206         };
1207
1208         std::list<Line> _lines;
1209         double          _y_origin;
1210         bool            _nothing_to_drag;
1211         bool            _integral;
1212 };
1213
1214 /** Drag of one edge of an xfade
1215  */
1216 class CrossfadeEdgeDrag : public Drag
1217 {
1218   public:
1219         CrossfadeEdgeDrag (Editor*, AudioRegionView*, ArdourCanvas::Item*, bool start);
1220
1221         void start_grab (GdkEvent*, Gdk::Cursor* c = 0);
1222         void motion (GdkEvent*, bool);
1223         void finished (GdkEvent*, bool);
1224         void aborted (bool);
1225
1226         bool y_movement_matters () const {
1227                 return false;
1228         }
1229
1230         virtual std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
1231                 return std::make_pair (4, 4);
1232         }
1233
1234   private:
1235         AudioRegionView* arv;
1236         bool start;
1237 };
1238
1239 class RulerZoomDrag : public Drag
1240 {
1241 public:
1242         RulerZoomDrag (Editor*, ArdourCanvas::Item*);
1243
1244         void start_grab (GdkEvent*, Gdk::Cursor* c = 0);
1245         void motion (GdkEvent *, bool);
1246         void finished (GdkEvent*, bool);
1247         void aborted (bool);
1248
1249         virtual bool allow_vertical_autoscroll () const {
1250                 return false;
1251         }
1252
1253 };
1254
1255 #endif /* __gtk2_ardour_editor_drag_h_ */
1256