Gracefully handle templates that lack contents in their description or created_with...
[ardour.git] / gtk2_ardour / midi_region_view.h
index cfdb50a99c140015b5b3a3b390a5aa06cfffcfe9..20a1ee5b25f85260a2cd4f3839d9e23e1860f8d8 100644 (file)
@@ -122,10 +122,11 @@ public:
        void resolve_note(uint8_t note_num, Evoral::Beats end_time);
 
        void cut_copy_clear (Editing::CutCopyOp);
-       bool paste (framepos_t pos, const ::Selection& selection, PasteContext& ctx);
+       bool paste (framepos_t pos, const ::Selection& selection, PasteContext& ctx, const int32_t sub_num);
        void paste_internal (framepos_t pos, unsigned paste_count, float times, const MidiCutBuffer&);
 
        void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext, bool);
+       void remove_canvas_patch_change (PatchChange* pc);
 
        /** Look up the given time and channel in the 'automation' and set keys accordingly.
         * @param time the time of the patch change event
@@ -179,7 +180,7 @@ public:
        void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
        void note_diff_remove_note (NoteBase* ev);
 
-       void apply_diff (bool as_subcommand = false);
+       void apply_diff (bool as_subcommand = false, bool was_copy = false);
        void abort_command();
 
        void   note_entered(NoteBase* ev);
@@ -199,10 +200,13 @@ public:
        void   select_range(framepos_t start, framepos_t end);
        void   invert_selection ();
 
+       Evoral::Beats earliest_in_selection ();
        void move_selection(double dx, double dy, double cumulative_dy);
-       void note_dropped (NoteBase* ev, ARDOUR::frameoffset_t, int8_t d_note);
+       void note_dropped (NoteBase* ev, double d_qn, int8_t d_note, bool copy);
+       NoteBase* copy_selection (NoteBase* primary);
+       void move_copies(double dx_qn, double dy, double cumulative_dy);
 
-       void select_notes (std::list<boost::shared_ptr<NoteType> >);
+       void select_notes (std::list<Evoral::event_id_t>);
        void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
        void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
 
@@ -223,8 +227,8 @@ public:
         */
        void begin_resizing(bool at_front);
 
-       void update_resizing (NoteBase*, bool, double, bool, double);
-       void commit_resizing (NoteBase*, bool, double, bool, double);
+       void update_resizing (NoteBase* primary, bool at_front, double delta_x, bool relative, double snap_delta, bool with_snap);
+       void commit_resizing (NoteBase* primary, bool at_front, double delat_x, bool relative, double snap_delta, bool with_snap);
        void abort_resizing ();
 
        /** Change the channel of the selection.
@@ -250,15 +254,18 @@ public:
 
        /** Snap a region relative pixel coordinate to pixel units.
         * @param x a pixel coordinate relative to region start
+        * @param ensure_snap do not use magnetic snap (required for snap delta calculation)
         * @return the snapped pixel coordinate relative to region start
         */
-       double snap_to_pixel(double x);
+       double snap_to_pixel(double x, bool ensure_snap = false);
 
        /** Snap a region relative pixel coordinate to frame units.
         * @param x a pixel coordinate relative to region start
+        * @param ensure_snap ignore SnapOff and magnetic snap.
+        * Required for inverting snap logic with modifier keys and snap delta calculation.
         * @return the snapped framepos_t coordinate relative to region start
         */
-       framepos_t snap_pixel_to_sample(double x);
+       framepos_t snap_pixel_to_sample(double x, bool ensure_snap = false);
 
        /** Convert a timestamp in beats into frames (both relative to region position) */
        framepos_t region_beats_to_region_frames(Evoral::Beats beats) const;
@@ -291,10 +298,12 @@ public:
                return _region_relative_time_converter_double;
        }
 
+       double session_relative_qn (double qn) const;
+
        void goto_previous_note (bool add_to_selection);
        void goto_next_note (bool add_to_selection);
        void change_note_lengths (bool, bool, Evoral::Beats beats, bool start, bool end);
-        void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
+       void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
        void transpose (bool up, bool fine, bool allow_smush);
        void nudge_notes (bool forward, bool fine);
        void channel_edit ();
@@ -306,7 +315,7 @@ public:
        Selection selection () const {
                return _selection;
        }
-       
+
        void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
 
        void enable_display (bool);
@@ -321,14 +330,23 @@ public:
         * \param t time in frames relative to the position of the region
         * \param y vertical position in pixels
         * \param length duration of the note in beats
-        * \param snap_t true to snap t to the grid, otherwise false.
+        * \param state the keyboard modifier mask for the canvas event (click).
+        * \param shift_snap true alters snap behavior to round down always (false if the gui has already done that).
+        */
+       void create_note_at (framepos_t t, double y, Evoral::Beats length, uint32_t state, bool shift_snap);
+
+       /** An external request to clear the note selection, remove MRV from editor
+        * selection.
         */
-       void create_note_at (framepos_t t, double y, Evoral::Beats length, bool snap_t);
+       void clear_selection ();
+
+       ARDOUR::InstrumentInfo& instrument_info() const;
+
+       void note_deleted (NoteBase*);
 
-       void clear_selection (bool signal = true) { clear_selection_except (0, signal); }
+       void show_verbose_cursor_for_new_note_value(boost::shared_ptr<NoteType> current_note,
+                                                   uint8_t new_note) const;
 
-        ARDOUR::InstrumentInfo& instrument_info() const;
-       
 protected:
        void region_resized (const PBD::PropertyChange&);
 
@@ -343,19 +361,10 @@ private:
 
        friend class MidiRubberbandSelectDrag;
        friend class MidiVerticalSelectDrag;
-
-       /** Emitted when the selection has been cleared in one MidiRegionView,
-        *  with the expectation that others will clear their selections in
-        *  sympathy.
-        */
-       static PBD::Signal1<void, MidiRegionView*> SelectionCleared;
-       PBD::ScopedConnection _selection_cleared_connection;
-       void selection_cleared (MidiRegionView *);
-
-       /** this handles the case when the "external" world wants us to clear our internal selections
-        */
-       PBD::ScopedConnection _clear_midi_selection_connection;
-       void clear_midi_selection () { clear_selection(); }
+       friend class NoteDrag;
+       friend class NoteCreateDrag;
+       friend class HitCreateDrag;
+       friend class MidiGhostRegion;
 
        friend class EditNoteDialog;
 
@@ -366,13 +375,19 @@ private:
        void start_playing_midi_note (boost::shared_ptr<NoteType> note);
        void start_playing_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
 
-       void clear_events (bool with_selection_signal = true);
+       /** Clear the note selection of just this midi region
+        */
+       void clear_selection_internal ();
+
+       void clear_editor_note_selection ();
+
+       void clear_events ();
 
        bool canvas_group_event(GdkEvent* ev);
        bool note_canvas_event(GdkEvent* ev);
 
        void midi_channel_mode_changed ();
-        PBD::ScopedConnection _channel_mode_changed_connection;
+       PBD::ScopedConnection _channel_mode_changed_connection;
        void instrument_settings_changed ();
        PBD::ScopedConnection _instrument_changed_connection;
 
@@ -384,13 +399,14 @@ private:
        void trim_note(NoteBase* ev, ARDOUR::MidiModel::TimeType start_delta,
                       ARDOUR::MidiModel::TimeType end_delta);
 
-       void clear_selection_except (NoteBase* ev, bool signal = true);
        void update_drag_selection (framepos_t start, framepos_t end, double y0, double y1, bool extend);
        void update_vertical_drag_selection (double last_y, double y, bool extend);
 
        void add_to_selection (NoteBase*);
        void remove_from_selection (NoteBase*);
 
+       std::string get_note_name (boost::shared_ptr<NoteType> note, uint8_t note_value) const;
+
        void show_verbose_cursor (std::string const &, double, double) const;
        void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
 
@@ -398,10 +414,11 @@ private:
 
        uint8_t  _current_range_min;
        uint8_t  _current_range_max;
-       
-       typedef std::list<NoteBase*>                          Events;
-       typedef std::vector< boost::shared_ptr<PatchChange> > PatchChanges;
-       typedef std::vector< boost::shared_ptr<SysEx> >       SysExes;
+
+       typedef boost::unordered_map<boost::shared_ptr<NoteType>, NoteBase*>                             Events;
+       typedef boost::unordered_map<ARDOUR::MidiModel::PatchChangePtr, boost::shared_ptr<PatchChange> > PatchChanges;
+       typedef boost::unordered_map<ARDOUR::MidiModel::constSysExPtr, boost::shared_ptr<SysEx> >        SysExes;
+       typedef std::vector<NoteBase*> CopyDragEvents;
 
        ARDOUR::BeatsFramesConverter _region_relative_time_converter;
        ARDOUR::BeatsFramesConverter _source_relative_time_converter;
@@ -409,6 +426,7 @@ private:
 
        boost::shared_ptr<ARDOUR::MidiModel> _model;
        Events                               _events;
+       CopyDragEvents                       _copy_drag_events;
        PatchChanges                         _patch_changes;
        SysExes                              _sys_exes;
        Note**                               _active_notes;
@@ -422,20 +440,12 @@ private:
        Evoral::Beats                        _step_edit_cursor_position;
        NoteBase*                            _channel_selection_scoped_note;
 
-       /** A group used to temporarily reparent _note_group to during start trims, so
-        *  that the notes don't move with the parent region view.
-        */
-       ArdourCanvas::Container*                 _temporary_note_group;
-
        MouseState _mouse_state;
        int _pressed_button;
 
        /** Currently selected NoteBase objects */
        Selection _selection;
 
-       bool _sort_needed;
-       void time_sort_events ();
-
        MidiCutBuffer* selection_as_cut_buffer () const;
 
        /** New notes (created in the current command) which should be selected
@@ -443,7 +453,7 @@ private:
        std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 
        /** Notes that should be selected when the model is redisplayed. */
-       std::set< boost::shared_ptr<NoteType> > _pending_note_selection;
+       std::set<Evoral::event_id_t> _pending_note_selection;
 
        /** New notes (created in the current command) which should have visible velocity
         * when they appear after the command is applied. */
@@ -455,22 +465,22 @@ private:
        PBD::ScopedConnection content_connection;
 
        NoteBase* find_canvas_note (boost::shared_ptr<NoteType>);
-       NoteBase* find_canvas_note (NoteType);
+       NoteBase* find_canvas_note (Evoral::event_id_t id);
        Events::iterator _optimization_iterator;
 
+       boost::shared_ptr<PatchChange> find_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr p);
+       boost::shared_ptr<SysEx> find_canvas_sys_ex (ARDOUR::MidiModel::SysExPtr s);
+
        void update_note (NoteBase*, bool update_ghost_regions = true);
        void update_sustained (Note *, bool update_ghost_regions = true);
        void update_hit (Hit *, bool update_ghost_regions = true);
 
-       void create_ghost_note (double, double);
-       void update_ghost_note (double, double);
+       void create_ghost_note (double, double, uint32_t state);
+       void update_ghost_note (double, double, uint32_t state);
 
        MidiListEditor* _list_editor;
        bool _no_sound_notes;
 
-       PBD::ScopedConnection note_delete_connection;
-       void maybe_remove_deleted_note_from_selection (NoteBase*);
-
        void snap_changed ();
        PBD::ScopedConnection snap_changed_connection;
 
@@ -497,26 +507,38 @@ private:
 
        void remove_ghost_note ();
        void mouse_mode_changed ();
-       void enter_internal ();
+       void enter_internal (uint32_t state);
        void leave_internal ();
+       void hide_verbose_cursor ();
 
        framecnt_t _last_display_zoom;
 
-       double _last_event_x;
-       double _last_event_y;
-       bool   _grabbed_keyboard;
-       bool   _entered;
+       double    _last_event_x;
+       double    _last_event_y;
+       bool      _grabbed_keyboard;
+       bool      _entered;
+       NoteBase* _entered_note;
 
        bool _mouse_changed_selection;
 
-       framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
-       
+       Gtkmm2ext::Color _patch_change_outline;
+       Gtkmm2ext::Color _patch_change_fill;
+
+       Evoral::Beats snap_frame_to_grid_underneath (framepos_t p, int32_t divisions, bool shift_snap) const;
+
        PBD::ScopedConnection _mouse_mode_connection;
 
        boost::shared_ptr<CursorContext> _press_cursor_ctx;
 
-        ARDOUR::ChannelMode get_channel_mode() const;
-        uint16_t get_selected_channels () const;
+       ARDOUR::ChannelMode get_channel_mode() const;
+       uint16_t get_selected_channels () const;
+
+       inline double contents_height() const { return (_height - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE - 2); }
+       inline double contents_note_range () const { return (double)(_current_range_max - _current_range_min + 1); }
+       inline double note_height() const { return contents_height() / contents_note_range(); }
+
+       double note_to_y (uint8_t note) const;
+       uint8_t y_to_note (double y) const;
 };