2 Copyright (C) 2001-2011 Paul Davis
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.
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.
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.
19 #ifndef __gtk_ardour_midi_region_view_h__
20 #define __gtk_ardour_midi_region_view_h__
25 #include <libgnomecanvasmm.h>
26 #include <libgnomecanvasmm/polygon.h>
28 #include "pbd/signals.h"
30 #include "ardour/midi_track.h"
31 #include "ardour/midi_model.h"
32 #include "ardour/diskstream.h"
33 #include "ardour/types.h"
36 #include "region_view.h"
37 #include "midi_time_axis.h"
38 #include "time_axis_view_item.h"
39 #include "automation_line.h"
42 #include "canvas-hit.h"
43 #include "canvas-note.h"
44 #include "canvas-note-event.h"
45 #include "canvas_patch_change.h"
46 #include "canvas-sysex.h"
56 struct PatchPrimaryKey;
60 class MidiTimeAxisView;
62 class AutomationTimeAxisView;
63 class AutomationRegionView;
69 class MidiRegionView : public RegionView
72 typedef Evoral::Note<Evoral::MusicalTime> NoteType;
73 typedef Evoral::Sequence<Evoral::MusicalTime>::Notes Notes;
75 MidiRegionView (ArdourCanvas::Group *,
77 boost::shared_ptr<ARDOUR::MidiRegion>,
78 double initial_samples_per_unit,
79 Gdk::Color const & basic_color);
81 MidiRegionView (const MidiRegionView& other);
82 MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
86 virtual void init (Gdk::Color const & basic_color, bool wfd);
88 const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const;
90 inline MidiTimeAxisView* midi_view() const
91 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
93 inline MidiStreamView* midi_stream_view() const
94 { return midi_view()->midi_view(); }
96 void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
97 Evoral::MusicalTime pos, Evoral::MusicalTime len);
98 void step_sustain (Evoral::MusicalTime beats);
99 void set_height (double);
100 void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
102 inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
104 void set_frame_color();
105 void color_handler ();
107 void show_step_edit_cursor (Evoral::MusicalTime pos);
108 void move_step_edit_cursor (Evoral::MusicalTime pos);
109 void hide_step_edit_cursor ();
110 void set_step_edit_cursor_width (Evoral::MusicalTime beats);
112 void redisplay_model();
114 GhostRegion* add_ghost (TimeAxisView&);
116 void add_note(const boost::shared_ptr<NoteType> note, bool visible);
117 void resolve_note(uint8_t note_num, double end_time);
119 void cut_copy_clear (Editing::CutCopyOp);
120 void paste (framepos_t pos, float times, const MidiCutBuffer&);
122 void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext, bool);
124 /** Look up the given time and channel in the 'automation' and set keys accordingly.
125 * @param time the time of the patch change event
126 * @param channel the MIDI channel of the event
127 * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
128 * will be set according to the result of the lookup
130 void get_patch_key_at (double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
132 /** Convert a given PatchChange into a PatchPrimaryKey
134 MIDI::Name::PatchPrimaryKey patch_change_to_patch_key (ARDOUR::MidiModel::PatchChangePtr);
136 /** Change old_patch to new_patch.
137 * @param old_patch the canvas patch change which is to be altered
138 * @param new_patch new patch
140 void change_patch_change (ArdourCanvas::CanvasPatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
141 void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::MusicalTime> const &);
143 void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::MusicalTime> const &);
144 void move_patch_change (ArdourCanvas::CanvasPatchChange &, Evoral::MusicalTime);
145 void delete_patch_change (ArdourCanvas::CanvasPatchChange *);
146 void edit_patch_change (ArdourCanvas::CanvasPatchChange *);
148 /** Alter a given patch to be its predecessor in the MIDNAM file.
150 void previous_patch (ArdourCanvas::CanvasPatchChange &);
152 /** Alters a given patch to be its successor in the MIDNAM file.
154 void next_patch (ArdourCanvas::CanvasPatchChange &);
156 void previous_bank (ArdourCanvas::CanvasPatchChange &);
157 void next_bank (ArdourCanvas::CanvasPatchChange &);
159 /** Displays all patch change events in the region as flags on the canvas.
161 void display_patch_changes();
163 /** Displays all system exclusive events in the region as flags on the canvas.
165 void display_sysexes();
169 void extend_active_notes();
171 void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
173 void start_note_diff_command (std::string name = "midi edit");
174 void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
175 void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
176 void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
177 void note_diff_remove_note (ArdourCanvas::CanvasNoteEvent* ev);
179 void apply_diff (bool as_subcommand = false);
180 void abort_command();
182 void note_entered(ArdourCanvas::CanvasNoteEvent* ev);
183 void note_left(ArdourCanvas::CanvasNoteEvent* ev);
184 void patch_entered (ArdourCanvas::CanvasPatchChange *);
185 void patch_left (ArdourCanvas::CanvasPatchChange *);
186 void note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
187 void unique_select(ArdourCanvas::CanvasNoteEvent* ev);
188 void note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add, bool extend=false);
189 void note_deselected(ArdourCanvas::CanvasNoteEvent* ev);
190 void delete_selection();
191 void delete_note (boost::shared_ptr<NoteType>);
192 size_t selection_size() { return _selection.size(); }
193 void select_all_notes ();
194 void select_range(framepos_t start, framepos_t end);
195 void invert_selection ();
197 void move_selection(double dx, double dy, double cumulative_dy);
198 void note_dropped (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::frameoffset_t, int8_t d_note);
200 void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
201 void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
203 /** Return true iff the note is within the extent of the region.
204 * @param visible will be set to true if the note is within the visible note range, false otherwise.
206 bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
208 /** Get the region position in pixels relative to session. */
209 double get_position_pixels();
211 /** Get the region end position in pixels relative to session. */
212 double get_end_position_pixels();
214 /** Begin resizing of some notes.
215 * Called by CanvasMidiNote when resizing starts.
216 * @param at_front which end of the note (true == note on, false == note off)
218 void begin_resizing(bool at_front);
220 void update_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
221 void commit_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
222 void abort_resizing ();
224 /** Change the channel of the selection.
225 * @param channel - the channel number of the new channel, zero-based
227 void change_channel(uint8_t channel);
234 SelectVerticalDragging,
238 MouseState mouse_state() const { return _mouse_state; }
240 void note_button_release ();
242 struct NoteResizeData {
243 ArdourCanvas::CanvasNote *canvas_note;
244 ArdourCanvas::SimpleRect *resize_rect;
247 /** Snap a region relative pixel coordinate to pixel units.
248 * @param x a pixel coordinate relative to region start
249 * @return the snapped pixel coordinate relative to region start
251 double snap_to_pixel(double x);
253 /** Snap a region relative pixel coordinate to frame units.
254 * @param x a pixel coordinate relative to region start
255 * @return the snapped framepos_t coordinate relative to region start
257 framepos_t snap_pixel_to_frame(double x);
259 /** Convert a timestamp in beats into frames (both relative to region position) */
260 framepos_t region_beats_to_region_frames(double beats) const;
261 /** Convert a timestamp in beats into absolute frames */
262 framepos_t region_beats_to_absolute_frames(double beats) const {
263 return _region->position() + region_beats_to_region_frames (beats);
265 /** Convert a timestamp in frames to beats (both relative to region position) */
266 double region_frames_to_region_beats(framepos_t) const;
268 /** Convert a timestamp in beats measured from source start into absolute frames */
269 framepos_t source_beats_to_absolute_frames(double beats) const;
270 /** Convert a timestamp in beats measured from source start into region-relative frames */
271 framepos_t source_beats_to_region_frames(double beats) const {
272 return source_beats_to_absolute_frames (beats) - _region->position();
274 /** Convert a timestamp in absolute frames to beats measured from source start*/
275 double absolute_frames_to_source_beats(framepos_t) const;
277 void goto_previous_note (bool add_to_selection);
278 void goto_next_note (bool add_to_selection);
279 void change_note_lengths (bool, bool, Evoral::MusicalTime beats, bool start, bool end);
280 void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
281 void transpose (bool up, bool fine, bool allow_smush);
282 void nudge_notes (bool forward);
283 void channel_edit ();
284 void velocity_edit ();
286 void show_list_editor ();
288 typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
289 Selection selection () const {
293 void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
295 void enable_display (bool);
297 void set_channel_selector_scoped_note(ArdourCanvas::CanvasNoteEvent* note){ _channel_selection_scoped_note = note; }
298 ArdourCanvas::CanvasNoteEvent* channel_selector_scoped_note(){ return _channel_selection_scoped_note; }
300 void trim_front_starting ();
301 void trim_front_ending ();
303 void create_note_at (framepos_t, double, double, bool);
305 void clear_selection (bool signal = true) { clear_selection_except (0, signal); }
307 ARDOUR::InstrumentInfo& instrument_info() const;
310 /** Allows derived types to specify their visibility requirements
311 * to the TimeAxisViewItem parent class.
313 MidiRegionView (ArdourCanvas::Group *,
315 boost::shared_ptr<ARDOUR::MidiRegion>,
316 double samples_per_unit,
317 Gdk::Color& basic_color,
318 TimeAxisViewItem::Visibility);
320 void region_resized (const PBD::PropertyChange&);
322 void set_flags (XMLNode *);
325 void reset_width_dependent_items (double pixel_width);
327 void parameter_changed (std::string const & p);
331 friend class MidiRubberbandSelectDrag;
332 friend class MidiVerticalSelectDrag;
334 /** Emitted when the selection has been cleared in one MidiRegionView,
335 * with the expectation that others will clear their selections in
338 static PBD::Signal1<void, MidiRegionView*> SelectionCleared;
339 PBD::ScopedConnection _selection_cleared_connection;
340 void selection_cleared (MidiRegionView *);
342 friend class EditNoteDialog;
344 /** Play the NoteOn event of the given note immediately
345 * and schedule the playback of the corresponding NoteOff event.
347 void play_midi_note (boost::shared_ptr<NoteType> note);
348 void start_playing_midi_note (boost::shared_ptr<NoteType> note);
349 void start_playing_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
351 void clear_events (bool with_selection_signal = true);
353 bool canvas_event(GdkEvent* ev);
354 bool note_canvas_event(GdkEvent* ev);
356 void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
357 void instrument_settings_changed ();
358 PBD::ScopedConnection _instrument_changed_connection;
360 void change_note_channel (ArdourCanvas::CanvasNoteEvent *, int8_t, bool relative=false);
361 void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
362 void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
363 void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
364 void change_note_length (ArdourCanvas::CanvasNoteEvent *, ARDOUR::MidiModel::TimeType);
365 void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
366 ARDOUR::MidiModel::TimeType end_delta);
368 void clear_selection_except (ArdourCanvas::CanvasNoteEvent* ev, bool signal = true);
369 void update_drag_selection (double last_x, double x, double last_y, double y, bool extend);
370 void update_vertical_drag_selection (double last_y, double y, bool extend);
372 void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
373 void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
375 void show_verbose_cursor (std::string const &, double, double) const;
376 void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
378 uint16_t _last_channel_selection;
379 uint8_t _current_range_min;
380 uint8_t _current_range_max;
382 typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
383 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasPatchChange> > PatchChanges;
384 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
386 boost::shared_ptr<ARDOUR::MidiModel> _model;
388 PatchChanges _patch_changes;
390 ArdourCanvas::CanvasNote** _active_notes;
391 ArdourCanvas::Group* _note_group;
392 ARDOUR::MidiModel::NoteDiffCommand* _note_diff_command;
393 ArdourCanvas::CanvasNote* _ghost_note;
394 double _last_ghost_x;
395 double _last_ghost_y;
396 ArdourCanvas::SimpleRect* _step_edit_cursor;
397 Evoral::MusicalTime _step_edit_cursor_width;
398 Evoral::MusicalTime _step_edit_cursor_position;
399 ArdourCanvas::CanvasNoteEvent* _channel_selection_scoped_note;
402 /** A group used to temporarily reparent _note_group to during start trims, so
403 * that the notes don't move with the parent region view.
405 ArdourCanvas::Group* _temporary_note_group;
407 MouseState _mouse_state;
410 /** Currently selected CanvasNoteEvents */
411 Selection _selection;
414 void time_sort_events ();
416 MidiCutBuffer* selection_as_cut_buffer () const;
418 /** New notes (created in the current command) which should be selected
419 * when they appear after the command is applied. */
420 std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
422 /** New notes (created in the current command) which should have visible velocity
423 * when they appear after the command is applied. */
424 std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
426 std::vector<NoteResizeData *> _resize_data;
428 /** connection used to connect to model's ContentChanged signal */
429 PBD::ScopedConnection content_connection;
431 ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
432 Events::iterator _optimization_iterator;
434 void update_note (ArdourCanvas::CanvasNote *, bool update_ghost_regions = true);
435 double update_hit (ArdourCanvas::CanvasHit *);
436 void create_ghost_note (double, double);
437 void update_ghost_note (double, double);
439 MidiListEditor* _list_editor;
440 bool _no_sound_notes;
442 PBD::ScopedConnection note_delete_connection;
443 void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
445 void snap_changed ();
446 PBD::ScopedConnection snap_changed_connection;
448 bool motion (GdkEventMotion*);
449 bool scroll (GdkEventScroll*);
450 bool key_press (GdkEventKey*);
451 bool key_release (GdkEventKey*);
452 bool button_press (GdkEventButton*);
453 bool button_release (GdkEventButton*);
454 bool enter_notify (GdkEventCrossing*);
455 bool leave_notify (GdkEventCrossing*);
457 void drop_down_keys ();
458 void maybe_select_by_position (GdkEventButton* ev, double x, double y);
459 void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
461 void display_patch_changes_on_channel (uint8_t, bool);
463 void connect_to_diskstream ();
464 void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
466 void remove_ghost_note ();
467 void mouse_mode_changed ();
468 double _last_event_x;
469 double _last_event_y;
471 framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
473 PBD::ScopedConnection _mouse_mode_connection;
475 Gdk::Cursor* pre_enter_cursor;
476 Gdk::Cursor* pre_press_cursor;
478 NotePlayer* _note_player;
482 #endif /* __gtk_ardour_midi_region_view_h__ */