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