editor_drag.h

Go to the documentation of this file.

/*
 * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2009-2015 David Robillard <d@drobilla.net>
 * Copyright (C) 2009-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2013-2014 Colin Fletcher <colin.m.fletcher@googlemail.com>
 * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
 * Copyright (C) 2015-2017 Nick Mainsbridge <mainsbridge@gmail.com>
 * Copyright (C) 2015-2018 Ben Loftis <ben@harrisonconsoles.com>
 * Copyright (C) 2016 Tim Mayberry <mojofunk@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef __gtk2_ardour_editor_drag_h_
#define __gtk2_ardour_editor_drag_h_
 
#include <list>
#include <vector>
 
#include <ydk/gdk.h>
#include <stdint.h>
 
#include "ardour/tempo.h"
#include "ardour/types.h"
 
#include "evoral/ControlList.h"
 
#include "canvas/types.h"
 
#include "gtkmm2ext/bindings.h"
 
#include "editor_items.h"
#include "mouse_cursors.h"
#include "editing.h"
#include "track_selection.h"
#include "region_view.h"
 
namespace ARDOUR {
        class Location;
        class Region;
        class TempoSection;
}
 
namespace ArdourCanvas {
        class Item;
        class Line;
        class Rectangle;
        class Lollipop;
}
 
namespace PBD {
        class StatefulDiffCommand;
}
 
class CueEditor;
class PatchChange;
class EditingContext;
class Editor;
class EditorCursor;
class TimeAxisView;
class Pianoroll;
class MidiTimeAxisView;
class Drag;
class NoteBase;
class TimeAxisView;
class RouteTimeAxisView;
class RegionSelection;
class MidiRegionView;
class MidiView;
class MeterMarker;
class ArdourMarker;
class TempoMarker;
class TempoCurve;
class ControlPoint;
class AudioRegionView;
class AutomationLine;
class AutomationTimeAxisView;
class VelocityDisplay;
 
class DragManager
{
public:
 
        DragManager (EditingContext* e);
        ~DragManager ();
 
        bool motion_handler (GdkEvent *, bool);
        bool mid_drag_key_event (GdkEventKey*);
        void abort ();
        void add (Drag *);
        void set (Drag *, GdkEvent *, Gdk::Cursor* c = MouseCursors::invalid_cursor());
        void start_grab (GdkEvent *, Gdk::Cursor* c = MouseCursors::invalid_cursor());
        bool end_grab (GdkEvent *);
        bool have_item (ArdourCanvas::Item *) const;
 
        void mark_double_click ();
 
        bool ending () const {
                return _ending;
        }
 
        bool active () const {
                return !_drags.empty ();
        }
 
        double current_pointer_x () const {
                return _current_pointer_x;
        }
 
        double current_pointer_y () const {
                return _current_pointer_y;
        }
 
        ARDOUR::samplepos_t current_pointer_sample () const {
                return _current_pointer_time.samples();
        }
 
        Temporal::timepos_t current_pointer_time () const {
                return _current_pointer_time;
        }
 
        bool preview_video () const;
 
        bool dragging_lollipop () const;
        std::list<Drag*> const & drags() const { return _drags; }
 
private:
        EditingContext* _editing_context;
        std::list<Drag*> _drags;
        bool _ending; 
        double _current_pointer_x; 
        double _current_pointer_y; 
        Temporal::timepos_t _current_pointer_time; 
};
 
class Drag
{
public:
        Drag (EditingContext&, ArdourCanvas::Item *, Temporal::TimeDomain td, ArdourCanvas::Item const * bounding_item, bool hide_snapped_cursor = true);
        virtual ~Drag ();
 
        void set_manager (DragManager* m) {
                _drags = m;
        }
 
        ArdourCanvas::Item const * bounding_item() const { return _bounding_item; }
        void set_bounding_item (ArdourCanvas::Item const * i);
 
        ArdourCanvas::Item* item () const {
                return _item;
        }
 
        Temporal::TimeDomain time_domain() const { return _time_domain; }
        void set_time_domain (Temporal::TimeDomain);
 
        void swap_grab (ArdourCanvas::Item *, Gdk::Cursor *, uint32_t);
        bool motion_handler (GdkEvent*, bool);
        void abort ();
 
        Temporal::timepos_t adjusted_time (Temporal::timepos_t const &, GdkEvent const *, bool snap = true) const;
        Temporal::timepos_t adjusted_current_time (GdkEvent const *, bool snap = true) const;
 
        bool was_double_click() const { return _was_double_click; }
        void set_double_click (bool yn) { _was_double_click = yn; }
 
        void set_grab_button_anyway (GdkEvent*);
 
        virtual void start_grab (GdkEvent* e, Gdk::Cursor* c = 0);
 
        virtual bool end_grab (GdkEvent *);
 
        virtual void motion (GdkEvent* e, bool f) = 0;
 
        virtual void finished (GdkEvent* e, bool m) = 0;
 
        virtual void aborted (bool m) = 0;
 
        virtual bool active (Editing::MouseMode m) {
                return true;
        }
 
        bool preview_video () const {
                return _preview_video;
        }
 
        typedef std::pair<int,int> MoveThreshold;
 
        virtual MoveThreshold move_threshold () const;
 
        virtual bool allow_vertical_autoscroll () const {
                return true;
        }
 
        virtual bool allow_horizontal_autoscroll () const {
                return true;
        }
 
        virtual bool x_movement_matters () const {
                return true;
        }
 
        virtual bool y_movement_matters () const {
                return true;
        }
 
        virtual bool mid_drag_key_event (GdkEventKey*)  { return false; }
 
        bool initially_vertical() const {
                return _initially_vertical;
        }
 
        virtual void setup_pointer_offset () {
                _pointer_offset = Temporal::timecnt_t();
        }
 
        virtual void setup_video_offset () {
                /* video offset is always in audio time */
                _video_offset = Temporal::timecnt_t (Temporal::AudioTime);
                _preview_video = false;
        }
 
        int grab_button() const { return _grab_button; }
 
protected:
 
        double grab_x () const {
                return _grab_x;
        }
 
        double grab_y () const {
                return _grab_y;
        }
 
        Temporal::timepos_t pixel_duration_to_time (double x) const;
 
        Temporal::timepos_t raw_grab_time () const {
                return _raw_grab_time;
        }
 
        ARDOUR::samplepos_t grab_sample () const {
                return _grab_time.samples();
        }
 
        Temporal::timepos_t grab_time () const {
                return _grab_time;
        }
 
        double last_pointer_x () const {
                return _last_pointer_x;
        }
 
        double last_pointer_y () const {
                return _last_pointer_y;
        }
 
        ARDOUR::samplepos_t last_pointer_sample () const {
                return _last_pointer_time.samples();
        }
 
        Temporal::timepos_t last_pointer_time () const {
                return _last_pointer_time;
        }
 
        Temporal::timecnt_t snap_delta (guint const) const;
 
        double current_pointer_x () const;
        double current_pointer_y () const;
 
        /* sets snap delta from unsnapped pos */
        void setup_snap_delta (Temporal::timepos_t const & pos);
 
        std::shared_ptr<ARDOUR::Region> add_midi_region (MidiTimeAxisView*, bool commit);
 
        void show_verbose_cursor_time (Temporal::timepos_t const &);
        void show_verbose_cursor_duration (Temporal::timepos_t const & , Temporal::timepos_t const & , double xoffset = 0);
        void show_verbose_cursor_text (std::string const &);
        void show_view_preview (Temporal::timepos_t const &);
 
        EditingContext& editing_context;
        DragManager* _drags;
        ArdourCanvas::Item* _item; 
        ArdourCanvas::Item const * _bounding_item; 
        Temporal::timecnt_t _pointer_offset;
        Temporal::timecnt_t _video_offset;
        bool _preview_video;
        bool _x_constrained; 
        bool _y_constrained; 
        bool _was_rolling; 
        ARDOUR::timepos_t _earliest_time_limit; 
        bool _copy;
 
private:
        bool _trackview_only; 
        bool _hide_snapped_cursor; 
        bool _move_threshold_passed; 
        bool _starting_point_passed; 
        bool _initially_vertical; 
        bool _was_double_click; 
        double _grab_x; 
        double _grab_y; 
        double _last_pointer_x; 
        double _last_pointer_y; 
        Temporal::timepos_t _raw_grab_time; 
        Temporal::timepos_t _grab_time; 
        Temporal::timepos_t _last_pointer_time; 
        Temporal::TimeDomain _time_domain;
 
        /* difference between some key position's snapped and unsnapped
         *  samplepos. used for relative snap.
         */
        Temporal::timecnt_t _snap_delta;
        bool _constraint_pressed; 
        int _grab_button;
 
        Gtkmm2ext::Bindings::DragsBlockBindings binding_blocker;
};
 
class EditorDrag : public Drag
{
  public:
        EditorDrag (Editor&, ArdourCanvas::Item *, Temporal::TimeDomain td, ArdourCanvas::Item const * bounding_item, bool hide_snapped_cursor = true);
  protected:
        Editor& _editor;
};
 
class RegionDrag;
 
class DraggingView
{
public:
        DraggingView (RegionView *, RegionDrag *, TimeAxisView* original_tav);
 
        RegionView* view; 
        int time_axis_view;
        double layer;
        double initial_y; 
        Temporal::timepos_t initial_position; 
        Temporal::timepos_t initial_end; 
        samplepos_t anchored_fade_length; 
        std::shared_ptr<ARDOUR::Playlist> initial_playlist;
        TimeAxisView* initial_time_axis_view;
};
 
class RegionDrag : public EditorDrag, public sigc::trackable
{
public:
        RegionDrag (Editor&, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, Temporal::TimeDomain, bool hide_snapped_cursor = true);
        virtual ~RegionDrag () {}
 
protected:
 
        RegionView* _primary; 
        std::list<DraggingView> _views; 
 
        std::vector<TimeAxisView*> _time_axis_views;
        int find_time_axis_view (TimeAxisView *) const;
        int apply_track_delta (const int start, const int delta, const int skip, const bool distance_only = false) const;
 
        int _visible_y_low;
        int _visible_y_high;
        uint32_t _ntracks;
 
        void setup_video_offset ();
 
        friend class DraggingView;
 
protected:
        void add_stateful_diff_commands_for_playlists (ARDOUR::PlaylistSet const &);
 
private:
 
        void region_going_away (RegionView *);
        PBD::ScopedConnection death_connection;
};
 
class RegionSlipContentsDrag : public RegionDrag
{
public:
 
        RegionSlipContentsDrag (Editor&, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, Temporal::TimeDomain td);
        virtual ~RegionSlipContentsDrag () {}
 
        virtual void start_grab (GdkEvent *, Gdk::Cursor *);
        virtual void motion (GdkEvent *, bool);
        virtual void finished (GdkEvent *, bool);
        virtual void aborted (bool);
};
 
class RegionBrushDrag : public RegionDrag
{
public:
        RegionBrushDrag (Editor&, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, Temporal::TimeDomain td);
        virtual ~RegionBrushDrag () {}
 
        virtual void start_grab (GdkEvent *, Gdk::Cursor *);
        virtual void motion (GdkEvent *, bool);
        virtual void finished (GdkEvent *, bool);
        virtual void aborted (bool);
private:
        typedef std::set<Temporal::timepos_t> TimePositionSet;
        TimePositionSet _already_pasted;
};
 
class RegionMotionDrag : public RegionDrag
{
public:
 
        RegionMotionDrag (Editor&, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, Temporal::TimeDomain td);
        virtual ~RegionMotionDrag () {}
 
        virtual void start_grab (GdkEvent *, Gdk::Cursor *);
        virtual void motion (GdkEvent *, bool);
        virtual void finished (GdkEvent *, bool);
        virtual void aborted (bool);
 
        virtual bool regions_came_from_canvas () const = 0;
 
protected:
 
        double compute_x_delta (GdkEvent const *, Temporal::timepos_t &);
        virtual bool y_movement_allowed (int, double, int skip_invisible = 0) const;
        void collect_ripple_views ();
 
        bool _ignore_video_lock;
        Temporal::timepos_t _last_position; 
        double _total_x_delta;
        int _last_pointer_time_axis_view;
        double _last_pointer_layer;
        std::vector<ArdourMarker*> ripple_markers;
 
private:
        uint32_t _ndropzone;
        uint32_t _pdropzone;
        uint32_t _ddropzone;
};
 
 
class RegionMoveDrag : public RegionMotionDrag
{
public:
        RegionMoveDrag (Editor&, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool, Temporal::TimeDomain);
        virtual ~RegionMoveDrag () {}
 
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        void clear_draggingview_list ();
 
        bool regions_came_from_canvas () const {
                return true;
        }
 
        void setup_pointer_offset ();
 
private:
        void finished_no_copy (
                bool const,
                bool const,
                Temporal::timepos_t const &,
                int32_t const ev_state
                );
 
        void finished_copy (
                bool const,
                bool const,
                Temporal::timepos_t const &,
                int32_t const ev_state
                );
 
        RegionView* insert_region_into_playlist (
                std::shared_ptr<ARDOUR::Region>,
                RouteTimeAxisView*,
                ARDOUR::layer_t,
                Temporal::timepos_t const &,
                ARDOUR::PlaylistSet&
                );
 
        void remove_region_from_playlist (
                std::shared_ptr<ARDOUR::Region>,
                std::shared_ptr<ARDOUR::Playlist>,
                ARDOUR::PlaylistSet& modified_playlists
                );
 
 
        void collect_new_region_view (RegionView *);
        RouteTimeAxisView* create_destination_time_axis (std::shared_ptr<ARDOUR::Region>, TimeAxisView* original);
 
        RegionView* _new_region_view;
};
 
class RegionInsertDrag : public RegionMotionDrag
{
public:
        RegionInsertDrag (Editor&, std::shared_ptr<ARDOUR::Region>, RouteTimeAxisView*, Temporal::timepos_t const &, Temporal::TimeDomain);
 
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool regions_came_from_canvas () const {
                return false;
        }
};
 
class RegionCutDrag : public EditorDrag
{
public:
        RegionCutDrag (Editor&, ArdourCanvas::Item*, samplepos_t);
        ~RegionCutDrag ();
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent*, bool);
        void finished (GdkEvent*, bool);
        void aborted (bool);
};
 
class RegionCreateDrag : public EditorDrag
{
public:
        RegionCreateDrag (Editor&, ArdourCanvas::Item *, TimeAxisView *);
 
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
private:
        MidiTimeAxisView* _view;
        std::shared_ptr<ARDOUR::Region> _region;
};
 
class NoteResizeDrag : public Drag
{
public:
        NoteResizeDrag (EditingContext&, ArdourCanvas::Item *);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
private:
        MidiView*     midi_view;
        bool          relative;
        bool          at_front;
        bool         _was_selected;
        double       _snap_delta;
};
 
class NoteDrag : public Drag
{
public:
        NoteDrag (EditingContext&, ArdourCanvas::Item*);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        void setup_pointer_offset ();
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
private:
 
        Temporal::timecnt_t total_dx (GdkEvent * event) const; // total movement in quarter notes
        int8_t total_dy () const;
 
        MidiView* _view;
        NoteBase* _primary;
        Temporal::timecnt_t _cumulative_dx;
        double _cumulative_dy;
        Temporal::timepos_t  _earliest; // earliest note in note selection
        bool   _was_selected;
        double _note_height;
};
 
class NoteCreateDrag : public Drag
{
public:
        NoteCreateDrag (EditingContext&, ArdourCanvas::Item *, MidiView *);
        ~NoteCreateDrag ();
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool active (Editing::MouseMode mode) {
                return mode == Editing::MouseDraw || mode == Editing::MouseContent;
        }
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return false;
        }
 
private:
        double y_to_region (double) const;
        Temporal::Beats round_to_grid (Temporal::timepos_t const & pos, GdkEvent const * event) const;
 
        MidiView* _midi_view;
        ArdourCanvas::Rectangle* _drag_rect;
        Temporal::timepos_t _note[2];
};
 
class HitCreateDrag : public Drag
{
public:
        HitCreateDrag (EditingContext&, ArdourCanvas::Item *, MidiView *);
        ~HitCreateDrag ();
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool) {}
        void finished (GdkEvent *, bool);
        void aborted (bool) {}
 
        bool active (Editing::MouseMode mode) {
                return mode == Editing::MouseDraw || mode == Editing::MouseContent;
        }
 
        bool y_movement_matters () const {
                return false;
        }
 
private:
        double y_to_region (double) const;
 
        MidiView*           _midi_view;
        int                 _y;
 
};
 
class NoteBrushDrag : public Drag
{
public:
        NoteBrushDrag (EditingContext&, ArdourCanvas::Item *, MidiView *, Temporal::Beats specified_length = Temporal::Beats(), int stride_multiple = 1, int held_note = -1);
        ~NoteBrushDrag ();
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool) {}
 
        bool active (Editing::MouseMode mode) {
                return mode == Editing::MouseDraw || mode == Editing::MouseContent;
        }
 
        bool y_movement_matters () const {
                return false;
        }
 
private:
        double y_to_region (double) const;
        Temporal::Beats get_stride (Temporal::Beats const & pos, Temporal::BBT_Offset const & quantization);
 
        MidiView*           _midi_view;
        Temporal::timepos_t _last_pos;
        int                 _y;
        Temporal::Beats      stride;
        Temporal::Beats      next_grid;
        bool                 added_notes;
        Temporal::Beats      specified_length;
        int                  stride_multiple;
        int                  held_note;
};
 
class PatchChangeDrag : public Drag
{
public:
        PatchChangeDrag (EditingContext&, PatchChange *, MidiView *);
 
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool y_movement_matters () const {
                return false;
        }
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        void setup_pointer_offset ();
 
private:
        MidiView* _region_view;
        PatchChange* _patch_change;
        double _cumulative_dx;
};
 
class AVDraggingView
{
public:
        AVDraggingView (RegionView *);
 
        RegionView* view; 
        samplepos_t initial_position; 
};
 
class VideoTimeLineDrag : public EditorDrag
{
public:
        VideoTimeLineDrag (Editor&e, ArdourCanvas::Item *i);
 
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 
        bool y_movement_matters () const {
                return false;
        }
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        void aborted (bool);
 
protected:
        std::list<AVDraggingView> _views; 
 
private:
        ARDOUR::sampleoffset_t _startdrag_video_offset;
        ARDOUR::sampleoffset_t _max_backwards_drag;
        bool _stuck;
};
 
class TrimDrag : public RegionDrag
{
public:
        enum Operation {
                StartTrim,
                EndTrim
        };
 
        TrimDrag (Editor&, ArdourCanvas::Item *, RegionView*, std::list<RegionView*> const &, Temporal::TimeDomain td, bool preserve_fade_anchor = false);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool y_movement_matters () const {
                return false;
        }
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        void setup_pointer_offset ();
 
private:
 
        Operation _operation;
 
        bool _preserve_fade_anchor;
        bool _jump_position_when_done;
 
        std::vector<RegionView::DisplaySuspender> suspenders;
};
 
class MeterMarkerDrag : public EditorDrag
{
public:
        MeterMarkerDrag (Editor&, ArdourCanvas::Item *, bool);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return false;
        }
 
        void setup_pointer_offset ();
 
private:
        MeterMarker* _marker;
        Temporal::TempoMap::WritableSharedPtr map;
        Temporal::superclock_t initial_sclock;
 
        bool _movable;
        Editing::GridType _old_grid_type;
        Editing::SnapMode _old_snap_mode;
        XMLNode* before_state;
};
 
class TempoCurveDrag : public EditorDrag
{
public:
        TempoCurveDrag (Editor&, ArdourCanvas::Item*);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
private:
        Temporal::TempoPoint* point;
        double initial_bpm;
        Temporal::TempoMap::WritableSharedPtr map;
        XMLNode* _before_state;
};
 
class TempoMarkerDrag : public EditorDrag
{
public:
        TempoMarkerDrag (Editor&, ArdourCanvas::Item *);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return true;
        }
 
        void setup_pointer_offset ();
 
private:
        TempoMarker* _marker;
        Temporal::TempoPoint const * _real_section;
        Temporal::TempoMap::WritableSharedPtr map;
 
        bool _movable;
        double _grab_bpm;
        Temporal::Beats _grab_qn;
        XMLNode* _before_state;
};
 
class BBTMarkerDrag : public EditorDrag
{
public:
        BBTMarkerDrag (Editor&, ArdourCanvas::Item *);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return false;
        }
 
        void setup_pointer_offset ();
 
private:
        BBTMarker* _marker;
        Temporal::MusicTimePoint const * _point;
        Temporal::TempoMap::WritableSharedPtr map;
 
        XMLNode* _before_state;
};
 
class MappingEndDrag : public EditorDrag
{
public:
        MappingEndDrag (Editor&, ArdourCanvas::Item *, Temporal::TempoMap::WritableSharedPtr&, Temporal::TempoPoint&, Temporal::TempoPoint& after, XMLNode& before_state);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool allow_horizontal_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return false;
        }
 
        void setup_pointer_offset ();
 
private:
        Temporal::TempoPoint& _tempo;
        Temporal::TempoPoint& _after;
        double _grab_bpm;
        Temporal::TempoMap::WritableSharedPtr map;
 
        XMLNode* _before_state;
        bool     _drag_valid;
};
 
class MappingTwistDrag : public EditorDrag
{
public:
        MappingTwistDrag (Editor&, ArdourCanvas::Item *, Temporal::TempoMap::WritableSharedPtr&,
                          Temporal::TempoPoint& prev,
                          Temporal::TempoPoint& focus,
                          Temporal::TempoPoint& next,
                          XMLNode&,
                          bool ramped);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool allow_horizontal_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return false;
        }
 
        void setup_pointer_offset ();
 
private:
        Temporal::TempoPoint& prev;
        Temporal::TempoPoint& focus;
        Temporal::TempoPoint& next;
        Temporal::TempoMap::WritableSharedPtr map;
 
        double direction;
        double delta;
        double initial_focus_npm;
        double initial_pre_npm;
 
        XMLNode* _before_state;
        bool     _drag_valid;
        bool     _do_ramp;
};
 
 
class TempoTwistDrag : public EditorDrag
{
public:
        TempoTwistDrag (Editor&, ArdourCanvas::Item *);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return true;
        }
 
        void setup_pointer_offset ();
 
private:
        Temporal::Beats _grab_qn;
        Temporal::TempoPoint* _tempo;
        Temporal::TempoPoint const * _next_tempo;
        Temporal::TempoMap::WritableSharedPtr map;
        bool _drag_valid;
        XMLNode* _before_state;
};
 
class TempoEndDrag : public EditorDrag
{
public:
        TempoEndDrag (Editor&, ArdourCanvas::Item *);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return true;
        }
 
        void setup_pointer_offset ();
 
private:
        Temporal::Beats _grab_qn;
        Temporal::TempoPoint * _tempo;
        Temporal::TempoPoint * previous_tempo;
        Temporal::TempoMap::WritableSharedPtr map;
 
        XMLNode* _before_state;
        bool _drag_valid;
};
 
class CursorDrag : public EditorDrag
{
public:
        CursorDrag (Editor&, EditorCursor&, bool);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return true;
        }
 
private:
        void fake_locate (samplepos_t);
 
        EditorCursor& _cursor;
        bool _stop; 
        double _grab_zoom; 
 
        //used for zooming
        int _last_mx;
        int _last_my;
        int _last_dx;
        int _last_y_delta;
};
 
class FadeInDrag : public RegionDrag
{
public:
        FadeInDrag (Editor&, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, Temporal::TimeDomain);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool y_movement_matters () const {
                return false;
        }
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        void setup_pointer_offset ();
};
 
class FadeOutDrag : public RegionDrag
{
public:
        FadeOutDrag (Editor&, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, Temporal::TimeDomain td);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool y_movement_matters () const {
                return false;
        }
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        void setup_pointer_offset ();
};
 
class MarkerDrag : public EditorDrag
{
public:
        MarkerDrag (Editor&, ArdourCanvas::Item *);
        ~MarkerDrag ();
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return false;
        }
 
        void setup_pointer_offset ();
        void setup_video_offset ();
 
private:
        void update_item (ARDOUR::Location *);
 
        ArdourMarker* _marker; 
        bool _selection_changed;
        struct CopiedLocationMarkerInfo {
                ARDOUR::Location* location;
                std::vector<ArdourMarker*> markers;
                bool    move_both;
                CopiedLocationMarkerInfo (ARDOUR::Location* l, ArdourMarker* m);
        };
 
        std::vector<ARDOUR::Location::ChangeSuspender> lcs;
 
        typedef std::list<CopiedLocationMarkerInfo> CopiedLocationInfo;
        CopiedLocationInfo _copied_locations;
        ArdourCanvas::Points _points;
};
 
class ControlPointDrag : public Drag
{
public:
        ControlPointDrag (EditingContext&, ArdourCanvas::Item *);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool active (Editing::MouseMode m);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
 
private:
 
        ControlPoint* _point;
        double _fixed_grab_x;
        double _fixed_grab_y;
        double _cumulative_y_drag;
        bool     _pushing;
        uint32_t _final_index;
        static double _zero_gain_fraction;
 
        Temporal::timecnt_t total_dt (GdkEvent*) const;
};
 
class LineDrag : public Drag
{
public:
        LineDrag (EditingContext &e, ArdourCanvas::Item *i, std::function<void(GdkEvent*,Temporal::timepos_t const &,double)>);
        ~LineDrag ();
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
private:
 
        AutomationLine* _line;
        double _fixed_grab_x;
        double _fixed_grab_y;
        double _cumulative_y_drag;
        uint32_t _before;
        uint32_t _after;
        bool    have_command;
        std::function<void(GdkEvent*,Temporal::timepos_t const &,double)> click_functor;
};
 
class FeatureLineDrag : public Drag
{
public:
        FeatureLineDrag (Editor&e, ArdourCanvas::Item *i);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
private:
 
        ArdourCanvas::Line* _line;
        AudioRegionView* _arv;
 
        double _region_view_grab_x;
        double _cumulative_x_drag;
 
        float _before;
        uint32_t _max_x;
};
 
class RubberbandSelectDrag : public Drag
{
public:
        RubberbandSelectDrag (EditingContext&, ArdourCanvas::Item *, std::function<bool(GdkEvent*,Temporal::timepos_t const &)> click_functor);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        void do_select_things (GdkEvent *, bool);
 
        virtual void select_things (int button_state, Temporal::timepos_t const & x1, Temporal::timepos_t const & x2, double y1, double y2, bool drag_in_progress);
        virtual void deselect_things ();
 
  protected:
        bool _vertical_only;
        std::function<bool(GdkEvent*,Temporal::timepos_t const &)> click_functor;
};
 
class MidiRubberbandSelectDrag : public RubberbandSelectDrag
{
  public:
        MidiRubberbandSelectDrag (EditingContext&, MidiView *);
 
        void select_things (int, Temporal::timepos_t const &, Temporal::timepos_t const &, double, double, bool);
        void deselect_things ();
        void finished (GdkEvent *, bool);
 
  private:
        MidiView* _midi_view;
};
 
class MidiVerticalSelectDrag : public RubberbandSelectDrag
{
public:
        MidiVerticalSelectDrag (EditingContext&, MidiView *);
 
        void select_things (int, Temporal::timepos_t const &, Temporal::timepos_t const &, double, double, bool);
        void deselect_things ();
 
private:
        MidiView* _midi_view;
};
 
class TimeFXDrag : public RegionDrag
{
public:
        TimeFXDrag (Editor&, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, Temporal::TimeDomain td);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
private:
        bool _dragging_start;
};
 
class SelectionDrag : public EditorDrag
{
public:
        enum Operation {
                CreateSelection,
                SelectionStartTrim,
                SelectionEndTrim,
                SelectionMove,
                SelectionExtend
        };
 
        SelectionDrag (Editor&, ArdourCanvas::Item *, Operation);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        void setup_pointer_offset ();
 
private:
        Operation _operation;
        bool _add;
        TrackSelection _track_selection_at_start;
        bool _time_selection_at_start;
        Temporal::timepos_t start_at_start;
        Temporal::timepos_t end_at_start;
};
 
class SelectionMarkerDrag : public EditorDrag
{
public:
        SelectionMarkerDrag (Editor&, ArdourCanvas::Item*);
 
        void start_grab (GdkEvent*, Gdk::Cursor* c = 0);
        void motion (GdkEvent*, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
private:
        bool                _edit_start;
        Temporal::timepos_t _start_at_start;
        Temporal::timepos_t _end_at_start;
};
 
class RangeMarkerBarDrag : public EditorDrag
{
public:
        enum Operation {
                CreateSkipMarker,
                CreateRangeMarker,
                CreateTransportMarker,
                CreateCDMarker
        };
 
        RangeMarkerBarDrag (Editor&, ArdourCanvas::Item *, Operation);
        ~RangeMarkerBarDrag ();
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return false;
        }
 
private:
        void update_item (ARDOUR::Location *);
 
        Operation _operation;
        ArdourCanvas::Rectangle* _drag_rect;
};
 
class MouseZoomDrag : public EditorDrag
{
public:
        MouseZoomDrag (Editor&, ArdourCanvas::Item *);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
private:
        bool _zoom_out;
};
 
class AutomationRangeDrag : public Drag
{
public:
        AutomationRangeDrag (EditingContext&, AutomationTimeAxisView *, float initial_value, std::list<ARDOUR::TimelineRange> const &);
        AutomationRangeDrag (EditingContext&, std::list<RegionView*> const &, std::list<ARDOUR::TimelineRange> const &, double y_origin, double y_height);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool x_movement_matters () const {
                return false;
        }
 
private:
        void setup (std::list<std::shared_ptr<AutomationLine> > const &);
        double y_fraction (double global_y_position) const;
        double value (std::shared_ptr<ARDOUR::AutomationList> list, Temporal::timepos_t const & x) const;
 
        std::list<ARDOUR::TimelineRange> _ranges;
 
        struct Line {
                std::shared_ptr<AutomationLine> line; 
                std::list<ControlPoint*> points; 
                std::pair<Temporal::timepos_t, Temporal::timepos_t> range; 
                XMLNode* state; 
        };
 
        std::list<Line> _lines;
        double          _y_origin;
        double          _y_height;
        bool            _nothing_to_drag;
        bool            _integral;
        float_t                 _initial_value;
};
 
class CrossfadeEdgeDrag : public Drag
{
public:
        CrossfadeEdgeDrag (Editor&, AudioRegionView*, ArdourCanvas::Item*, bool start);
 
        void start_grab (GdkEvent*, Gdk::Cursor* c = 0);
        void motion (GdkEvent*, bool);
        void finished (GdkEvent*, bool);
        void aborted (bool);
 
        bool y_movement_matters () const {
                return false;
        }
 
private:
        AudioRegionView* arv;
        bool start;
};
 
class RegionMarkerDrag : public Drag
{
  public:
        RegionMarkerDrag (Editor&, RegionView*, ArdourCanvas::Item*);
        ~RegionMarkerDrag ();
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool y_movement_matters () const {
                return false;
        }
 
        void setup_pointer_offset ();
 
  private:
        RegionView* rv;
        ArdourMarker* view;
        ARDOUR::CueMarker model;
        ARDOUR::CueMarker dragging_model;
};
 
 
class LollipopDrag : public Drag
{
  public:
        LollipopDrag (EditingContext&, ArdourCanvas::Item*);
        ~LollipopDrag ();
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
        void aborted (bool);
 
        bool allow_vertical_autoscroll () const {
                return false;
        }
 
        bool allow_horizontal_autoscroll () const {
                return false;
        }
 
        bool x_movement_matters () const {
                return false;
        }
 
        void setup_pointer_offset ();
 
  private:
        VelocityDisplay*          _display;
        ArdourCanvas::Lollipop*   _primary;
};
 
template<typename OrderedPointList, typename OrderedPoint>
class FreehandLineDrag : public Drag
{
  public:
        FreehandLineDrag (EditingContext&, ArdourCanvas::Item*, ArdourCanvas::Rectangle&, bool, Temporal::TimeDomain);
        ~FreehandLineDrag ();
 
        void motion (GdkEvent*, bool);
        void finished (GdkEvent*, bool);
        bool mid_drag_key_event (GdkEventKey*);
        virtual void point_added  (ArdourCanvas::Duple const & d, ArdourCanvas::Rectangle const & r, double last_x) {}
        virtual void line_extended  (ArdourCanvas::Duple const & from, ArdourCanvas::Duple const & to, ArdourCanvas::Rectangle const & r, double last_x) {
                point_added (to, r, last_x);
        }
 
  protected:
        ArdourCanvas::Item* parent; /* we do not own this. If null, use base_rect as the parent */
        ArdourCanvas::Rectangle& base_rect; /* we do not own this */
        ArdourCanvas::PolyLine* dragging_line;
        bool horizontally_bounded;
        int direction;
        int edge_x;
        bool did_snap;
        bool line_break_pending;
        OrderedPointList drawn_points;
        ArdourCanvas::Coord line_start_x;
        ArdourCanvas::Coord line_start_y;
 
        void maybe_add_point (GdkEvent*, Temporal::timepos_t const &, bool first_move);
};
 
class AutomationDrawDrag : public FreehandLineDrag<Evoral::ControlList::OrderedPoints, Evoral::ControlList::OrderedPoint>
{
  public:
        AutomationDrawDrag (EditingContext&, ArdourCanvas::Item*, ArdourCanvas::Rectangle&, bool, Temporal::TimeDomain, std::function<bool(GdkEvent*,Temporal::timepos_t const &)>);
        ~AutomationDrawDrag ();
 
        void finished (GdkEvent*, bool);
        void aborted (bool) {}
 
private:
        std::function<bool(GdkEvent*,Temporal::timepos_t const &)> click_functor;
};
 
class VelocityLineDrag : public FreehandLineDrag<Evoral::ControlList::OrderedPoints, Evoral::ControlList::OrderedPoint>
{
  public:
        VelocityLineDrag (EditingContext&, ArdourCanvas::Rectangle&, bool, Temporal::TimeDomain);
        ~VelocityLineDrag ();
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void finished (GdkEvent*, bool);
        void aborted (bool);
        void point_added  (ArdourCanvas::Duple const & d, ArdourCanvas::Rectangle const & r, double last_x);
        void line_extended (ArdourCanvas::Duple const & from, ArdourCanvas::Duple const & to, ArdourCanvas::Rectangle const & r, double last_x);
 
 private:
        VelocityDisplay* vd;
        bool drag_did_change;
};
 
class ClipStartDrag : public Drag
{
  public:
        ClipStartDrag (CueEditor&, ArdourCanvas::Rectangle &);
        ~ClipStartDrag ();
 
        void start_grab (GdkEvent*,Gdk::Cursor*);
        bool end_grab (GdkEvent*);
        void motion (GdkEvent*, bool);
        void finished (GdkEvent*, bool);
        void aborted (bool);
 
  private:
        CueEditor& ce;
        ArdourCanvas::Rectangle* dragging_rect;
        ArdourCanvas::Rect original_rect;
};
 
class ClipEndDrag : public Drag
{
  public:
        ClipEndDrag (CueEditor&, ArdourCanvas::Rectangle &);
        ~ClipEndDrag ();
 
        void start_grab (GdkEvent*,Gdk::Cursor*);
        bool end_grab (GdkEvent*);
        void motion (GdkEvent*, bool);
        void finished (GdkEvent*, bool);
        void aborted (bool);
 
  private:
        CueEditor& ce;
        ArdourCanvas::Rectangle* dragging_rect;
        ArdourCanvas::Rect original_rect;
};
 
#endif /* __gtk2_ardour_editor_drag_h_ */