2 * Copyright (C) 2006-2015 David Robillard <d@drobilla.net>
3 * Copyright (C) 2008-2012 Hans Baier <hansfbaier@googlemail.com>
4 * Copyright (C) 2008-2017 Paul Davis <paul@linuxaudiosystems.com>
5 * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
6 * Copyright (C) 2015-2016 Tim Mayberry <mojofunk@gmail.com>
7 * Copyright (C) 2015-2017 Nick Mainsbridge <mainsbridge@gmail.com>
8 * Copyright (C) 2015-2017 Robin Gareus <robin@gareus.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #ifndef __gtk_ardour_midi_region_view_h__
26 #define __gtk_ardour_midi_region_view_h__
32 #include "pbd/signals.h"
34 #include "ardour/midi_model.h"
35 #include "ardour/types.h"
38 #include "region_view.h"
39 #include "midi_time_axis.h"
40 #include "time_axis_view_item.h"
41 #include "automation_line.h"
52 struct PatchPrimaryKey;
60 class MidiTimeAxisView;
62 class AutomationTimeAxisView;
63 class AutomationRegionView;
71 class MidiRegionView : public RegionView
74 typedef Evoral::Note<Temporal::Beats> NoteType;
75 typedef Evoral::Sequence<Temporal::Beats>::Notes Notes;
77 MidiRegionView (ArdourCanvas::Container* parent,
78 RouteTimeAxisView& tv,
79 boost::shared_ptr<ARDOUR::MidiRegion> r,
80 double samples_per_pixel,
81 uint32_t basic_color);
83 MidiRegionView (ArdourCanvas::Container* parent,
84 RouteTimeAxisView& tv,
85 boost::shared_ptr<ARDOUR::MidiRegion> r,
86 double samples_per_pixel,
89 Visibility visibility);
92 MidiRegionView (const MidiRegionView& other);
93 MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
99 const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const;
101 inline MidiTimeAxisView* midi_view() const
102 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
104 inline MidiStreamView* midi_stream_view() const
105 { return midi_view()->midi_view(); }
107 void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
108 Temporal::Beats pos, Temporal::Beats len);
109 void step_sustain (Temporal::Beats beats);
110 void set_height (double);
111 void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
113 inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
115 uint32_t get_fill_color() const;
116 void color_handler ();
118 void show_step_edit_cursor (Temporal::Beats pos);
119 void move_step_edit_cursor (Temporal::Beats pos);
120 void hide_step_edit_cursor ();
121 void set_step_edit_cursor_width (Temporal::Beats beats);
123 void redisplay_model();
125 GhostRegion* add_ghost (TimeAxisView&);
127 NoteBase* add_note(const boost::shared_ptr<NoteType> note, bool visible);
128 void resolve_note(uint8_t note_num, Temporal::Beats end_time);
130 void cut_copy_clear (Editing::CutCopyOp);
131 bool paste (samplepos_t pos, const ::Selection& selection, PasteContext& ctx, const int32_t sub_num);
132 void paste_internal (samplepos_t pos, unsigned paste_count, float times, const MidiCutBuffer&);
134 void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext, bool);
135 void remove_canvas_patch_change (PatchChange* pc);
137 /** Look up the given time and channel in the 'automation' and set keys accordingly.
138 * @param time the time of the patch change event
139 * @param channel the MIDI channel of the event
140 * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
141 * will be set according to the result of the lookup
143 void get_patch_key_at (Temporal::Beats time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key) const;
145 /** Convert a given PatchChange into a PatchPrimaryKey
147 MIDI::Name::PatchPrimaryKey patch_change_to_patch_key (ARDOUR::MidiModel::PatchChangePtr);
149 /** Change old_patch to new_patch.
150 * @param old_patch the canvas patch change which is to be altered
151 * @param new_patch new patch
153 void change_patch_change (PatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
154 void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Temporal::Beats> const &);
156 void add_patch_change (samplecnt_t, Evoral::PatchChange<Temporal::Beats> const &);
157 void move_patch_change (PatchChange &, Temporal::Beats);
158 void delete_patch_change (PatchChange *);
159 void edit_patch_change (PatchChange *);
161 void delete_sysex (SysEx*);
163 /** Change a patch to the next or previous bank/program.
164 * @param bank If true, step bank, otherwise, step program.
165 * @param delta Amount to adjust number.
167 void step_patch (PatchChange& patch, bool bank, int delta);
169 /** Displays all patch change events in the region as flags on the canvas.
171 void display_patch_changes();
173 /** Displays all system exclusive events in the region as flags on the canvas.
175 void display_sysexes();
179 void extend_active_notes();
181 void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
183 void start_note_diff_command (std::string name = "midi edit");
184 void note_diff_add_change (NoteBase* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
185 void note_diff_add_change (NoteBase* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Temporal::Beats val);
186 void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
187 void note_diff_remove_note (NoteBase* ev);
189 void apply_diff (bool as_subcommand = false, bool was_copy = false);
190 void abort_command();
192 void note_entered(NoteBase* ev);
193 void note_left(NoteBase* ev);
194 void patch_entered (PatchChange *);
195 void patch_left (PatchChange *);
196 void sysex_entered (SysEx* p);
197 void sysex_left (SysEx* p);
198 void note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
199 void unique_select(NoteBase* ev);
200 void note_selected(NoteBase* ev, bool add, bool extend=false);
201 void note_deselected(NoteBase* ev);
202 void delete_selection();
203 void delete_note (boost::shared_ptr<NoteType>);
204 size_t selection_size() { return _selection.size(); }
205 void select_all_notes ();
206 void select_range(samplepos_t start, samplepos_t end);
207 void invert_selection ();
209 Temporal::Beats earliest_in_selection ();
210 void move_selection(double dx, double dy, double cumulative_dy);
211 void note_dropped (NoteBase* ev, double d_qn, int8_t d_note, bool copy);
212 NoteBase* copy_selection (NoteBase* primary);
213 void move_copies(double dx_qn, double dy, double cumulative_dy);
215 void select_notes (std::list<Evoral::event_id_t>);
216 void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
217 void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
219 /** Return true iff the note is within the extent of the region.
220 * @param visible will be set to true if the note is within the visible note range, false otherwise.
222 bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
224 /** Get the region position in pixels relative to session. */
225 double get_position_pixels();
227 /** Get the region end position in pixels relative to session. */
228 double get_end_position_pixels();
230 /** Begin resizing of some notes.
231 * Called by CanvasMidiNote when resizing starts.
232 * @param at_front which end of the note (true == note on, false == note off)
234 void begin_resizing(bool at_front);
236 void update_resizing (NoteBase* primary, bool at_front, double delta_x, bool relative, double snap_delta, bool with_snap);
237 void commit_resizing (NoteBase* primary, bool at_front, double delat_x, bool relative, double snap_delta, bool with_snap);
238 void abort_resizing ();
240 /** Change the channel of the selection.
241 * @param channel - the channel number of the new channel, zero-based
243 void change_channel(uint8_t channel);
250 SelectVerticalDragging,
254 MouseState mouse_state() const { return _mouse_state; }
256 struct NoteResizeData {
258 ArdourCanvas::Rectangle *resize_rect;
261 /** Snap a region relative pixel coordinate to pixel units.
262 * @param x a pixel coordinate relative to region start
263 * @param ensure_snap do not use magnetic snap (required for snap delta calculation)
264 * @return the snapped pixel coordinate relative to region start
266 double snap_to_pixel(double x, bool ensure_snap = false);
268 /** Snap a region relative pixel coordinate to sample units.
269 * @param x a pixel coordinate relative to region start
270 * @param ensure_snap ignore SnapOff and magnetic snap.
271 * Required for inverting snap logic with modifier keys and snap delta calculation.
272 * @return the snapped samplepos_t coordinate relative to region start
274 samplepos_t snap_pixel_to_sample(double x, bool ensure_snap = false);
276 /** Convert a timestamp in beats into samples (both relative to region position) */
277 samplepos_t region_beats_to_region_samples(Temporal::Beats beats) const;
278 /** Convert a timestamp in beats into absolute samples */
279 samplepos_t region_beats_to_absolute_samples(Temporal::Beats beats) const {
280 return _region->position() + region_beats_to_region_samples (beats);
282 /** Convert a timestamp in samples to beats (both relative to region position) */
283 Temporal::Beats region_samples_to_region_beats(samplepos_t) const;
284 double region_samples_to_region_beats_double(samplepos_t) const;
286 /** Convert a timestamp in beats measured from source start into absolute samples */
287 samplepos_t source_beats_to_absolute_samples(Temporal::Beats beats) const;
288 /** Convert a timestamp in beats measured from source start into region-relative samples */
289 samplepos_t source_beats_to_region_samples(Temporal::Beats beats) const {
290 return source_beats_to_absolute_samples (beats) - _region->position();
292 /** Convert a timestamp in absolute samples to beats measured from source start*/
293 Temporal::Beats absolute_samples_to_source_beats(samplepos_t) const;
295 ARDOUR::BeatsSamplesConverter const & region_relative_time_converter () const {
296 return _region_relative_time_converter;
299 ARDOUR::BeatsSamplesConverter const & source_relative_time_converter () const {
300 return _source_relative_time_converter;
303 ARDOUR::DoubleBeatsSamplesConverter const & region_relative_time_converter_double () const {
304 return _region_relative_time_converter_double;
307 double session_relative_qn (double qn) const;
309 void goto_previous_note (bool add_to_selection);
310 void goto_next_note (bool add_to_selection);
311 void change_note_lengths (bool, bool, Temporal::Beats beats, bool start, bool end);
312 void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
313 void transpose (bool up, bool fine, bool allow_smush);
314 void nudge_notes (bool forward, bool fine);
315 void channel_edit ();
316 void velocity_edit ();
318 void show_list_editor ();
320 typedef std::set<NoteBase*> Selection;
321 Selection selection () const {
325 void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
327 void enable_display (bool);
329 void set_channel_selector_scoped_note(NoteBase* note){ _channel_selection_scoped_note = note; }
330 NoteBase* channel_selector_scoped_note(){ return _channel_selection_scoped_note; }
332 void trim_front_starting ();
333 void trim_front_ending ();
335 /** Add a note to the model, and the view, at a canvas (click) coordinate.
336 * \param t time in samples relative to the position of the region
337 * \param y vertical position in pixels
338 * \param length duration of the note in beats
339 * \param state the keyboard modifier mask for the canvas event (click).
340 * \param shift_snap true alters snap behavior to round down always (false if the gui has already done that).
342 void create_note_at (samplepos_t t, double y, Temporal::Beats length, uint32_t state, bool shift_snap);
344 /** An external request to clear the note selection, remove MRV from editor
347 void clear_selection ();
349 ARDOUR::InstrumentInfo& instrument_info() const;
351 void note_deleted (NoteBase*);
353 void show_verbose_cursor_for_new_note_value(boost::shared_ptr<NoteType> current_note,
354 uint8_t new_note) const;
357 void region_resized (const PBD::PropertyChange&);
359 void set_flags (XMLNode *);
362 void reset_width_dependent_items (double pixel_width);
364 void parameter_changed (std::string const & p);
368 friend class MidiRubberbandSelectDrag;
369 friend class MidiVerticalSelectDrag;
370 friend class NoteDrag;
371 friend class NoteCreateDrag;
372 friend class HitCreateDrag;
373 friend class MidiGhostRegion;
375 friend class EditNoteDialog;
377 /** Play the NoteOn event of the given note immediately
378 * and schedule the playback of the corresponding NoteOff event.
380 void play_midi_note (boost::shared_ptr<NoteType> note);
381 void start_playing_midi_note (boost::shared_ptr<NoteType> note);
382 void start_playing_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
384 /** Clear the note selection of just this midi region
386 void clear_selection_internal ();
388 void clear_editor_note_selection ();
390 void clear_events ();
392 bool canvas_group_event(GdkEvent* ev);
393 bool note_canvas_event(GdkEvent* ev);
395 void midi_channel_mode_changed ();
396 PBD::ScopedConnection _channel_mode_changed_connection;
397 void instrument_settings_changed ();
398 PBD::ScopedConnection _instrument_changed_connection;
400 void change_note_channel (NoteBase *, int8_t, bool relative=false);
401 void change_note_velocity(NoteBase* ev, int8_t vel, bool relative=false);
402 void change_note_note(NoteBase* ev, int8_t note, bool relative=false);
403 void change_note_time(NoteBase* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
404 void change_note_length (NoteBase *, ARDOUR::MidiModel::TimeType);
405 void trim_note(NoteBase* ev, ARDOUR::MidiModel::TimeType start_delta,
406 ARDOUR::MidiModel::TimeType end_delta);
408 void update_drag_selection (samplepos_t start, samplepos_t end, double y0, double y1, bool extend);
409 void update_vertical_drag_selection (double last_y, double y, bool extend);
411 void add_to_selection (NoteBase*);
412 void remove_from_selection (NoteBase*);
414 std::string get_note_name (boost::shared_ptr<NoteType> note, uint8_t note_value) const;
416 void show_verbose_cursor (std::string const &, double, double) const;
417 void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
419 uint8_t get_velocity_for_add (ARDOUR::MidiModel::TimeType time) const;
421 uint8_t _current_range_min;
422 uint8_t _current_range_max;
424 typedef boost::unordered_map<boost::shared_ptr<NoteType>, NoteBase*> Events;
425 typedef boost::unordered_map<ARDOUR::MidiModel::PatchChangePtr, boost::shared_ptr<PatchChange> > PatchChanges;
426 typedef boost::unordered_map<ARDOUR::MidiModel::constSysExPtr, boost::shared_ptr<SysEx> > SysExes;
427 typedef std::vector<NoteBase*> CopyDragEvents;
429 ARDOUR::BeatsSamplesConverter _region_relative_time_converter;
430 ARDOUR::BeatsSamplesConverter _source_relative_time_converter;
431 ARDOUR::DoubleBeatsSamplesConverter _region_relative_time_converter_double;
433 boost::shared_ptr<ARDOUR::MidiModel> _model;
435 CopyDragEvents _copy_drag_events;
436 PatchChanges _patch_changes;
438 Note** _active_notes;
439 ArdourCanvas::Container* _note_group;
440 ARDOUR::MidiModel::NoteDiffCommand* _note_diff_command;
441 NoteBase* _ghost_note;
442 double _last_ghost_x;
443 double _last_ghost_y;
444 ArdourCanvas::Rectangle* _step_edit_cursor;
445 Temporal::Beats _step_edit_cursor_width;
446 Temporal::Beats _step_edit_cursor_position;
447 NoteBase* _channel_selection_scoped_note;
449 MouseState _mouse_state;
452 /** Currently selected NoteBase objects */
453 Selection _selection;
455 MidiCutBuffer* selection_as_cut_buffer () const;
457 /** New notes (created in the current command) which should be selected
458 * when they appear after the command is applied. */
459 std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
461 /** Notes that should be selected when the model is redisplayed. */
462 std::set<Evoral::event_id_t> _pending_note_selection;
464 /** New notes (created in the current command) which should have visible velocity
465 * when they appear after the command is applied. */
466 std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
468 std::vector<NoteResizeData *> _resize_data;
470 /** connection used to connect to model's ContentChanged signal */
471 PBD::ScopedConnection content_connection;
473 NoteBase* find_canvas_note (boost::shared_ptr<NoteType>);
474 NoteBase* find_canvas_note (Evoral::event_id_t id);
475 Events::iterator _optimization_iterator;
477 boost::shared_ptr<PatchChange> find_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr p);
478 boost::shared_ptr<SysEx> find_canvas_sys_ex (ARDOUR::MidiModel::SysExPtr s);
480 void update_note (NoteBase*, bool update_ghost_regions = true);
481 void update_sustained (Note *, bool update_ghost_regions = true);
482 void update_hit (Hit *, bool update_ghost_regions = true);
484 void create_ghost_note (double, double, uint32_t state);
485 void update_ghost_note (double, double, uint32_t state);
487 MidiListEditor* _list_editor;
488 bool _no_sound_notes;
490 void snap_changed ();
491 PBD::ScopedConnection snap_changed_connection;
493 bool motion (GdkEventMotion*);
494 bool scroll (GdkEventScroll*);
495 bool key_press (GdkEventKey*);
496 bool key_release (GdkEventKey*);
497 bool button_press (GdkEventButton*);
498 bool button_release (GdkEventButton*);
499 bool enter_notify (GdkEventCrossing*);
500 bool leave_notify (GdkEventCrossing*);
502 void drop_down_keys ();
503 void maybe_select_by_position (GdkEventButton* ev, double x, double y);
504 void get_events (Events& e, Evoral::Sequence<Temporal::Beats>::NoteOperator op, uint8_t val, int chan_mask = 0);
506 void display_patch_changes_on_channel (uint8_t, bool);
508 void connect_to_diskstream ();
509 void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
511 /** Get grid type as beats, or default to 1 if not snapped to beats. */
512 Temporal::Beats get_grid_beats(samplepos_t pos) const;
514 void remove_ghost_note ();
515 void mouse_mode_changed ();
516 void enter_internal (uint32_t state);
517 void leave_internal ();
518 void hide_verbose_cursor ();
520 samplecnt_t _last_display_zoom;
522 double _last_event_x;
523 double _last_event_y;
524 bool _grabbed_keyboard;
526 NoteBase* _entered_note;
528 bool _mouse_changed_selection;
530 Gtkmm2ext::Color _patch_change_outline;
531 Gtkmm2ext::Color _patch_change_fill;
533 Temporal::Beats snap_sample_to_grid_underneath (samplepos_t p, int32_t divisions, bool shift_snap) const;
535 PBD::ScopedConnection _mouse_mode_connection;
537 boost::shared_ptr<CursorContext> _press_cursor_ctx;
539 ARDOUR::ChannelMode get_channel_mode() const;
540 uint16_t get_selected_channels () const;
542 inline double contents_height() const { return (_height - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE - 2); }
543 inline double contents_note_range () const { return (double)(_current_range_max - _current_range_min + 1); }
544 inline double note_height() const { return contents_height() / contents_note_range(); }
546 double note_to_y (uint8_t note) const;
547 uint8_t y_to_note (double y) const;
551 #endif /* __gtk_ardour_midi_region_view_h__ */