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;
68 class MidiRegionView : public RegionView
71 typedef Evoral::Note<Evoral::MusicalTime> NoteType;
72 typedef Evoral::Sequence<Evoral::MusicalTime>::Notes Notes;
74 MidiRegionView (ArdourCanvas::Group *,
76 boost::shared_ptr<ARDOUR::MidiRegion>,
77 double initial_samples_per_unit,
78 Gdk::Color const & basic_color);
80 MidiRegionView (const MidiRegionView& other);
81 MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
85 virtual void init (Gdk::Color const & basic_color, bool wfd);
87 const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const;
89 inline MidiTimeAxisView* midi_view() const
90 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
92 inline MidiStreamView* midi_stream_view() const
93 { return midi_view()->midi_view(); }
95 void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
96 Evoral::MusicalTime pos, Evoral::MusicalTime len);
97 void step_sustain (Evoral::MusicalTime beats);
98 void set_height (double);
99 void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
101 inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
103 void set_frame_color();
104 void color_handler ();
106 void show_step_edit_cursor (Evoral::MusicalTime pos);
107 void move_step_edit_cursor (Evoral::MusicalTime pos);
108 void hide_step_edit_cursor ();
109 void set_step_edit_cursor_width (Evoral::MusicalTime beats);
111 void redisplay_model();
113 GhostRegion* add_ghost (TimeAxisView&);
115 void add_note(const boost::shared_ptr<NoteType> note, bool visible);
116 void resolve_note(uint8_t note_num, double end_time);
118 void cut_copy_clear (Editing::CutCopyOp);
119 void paste (framepos_t pos, float times, const MidiCutBuffer&);
121 /** Add a new patch change flag to the canvas.
122 * @param patch the patch change to add
123 * @param the text to display in the flag
125 void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext);
127 /** Look up the given time and channel in the 'automation' and set keys accordingly.
128 * @param time the time of the patch change event
129 * @param channel the MIDI channel of the event
130 * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
131 * will be set according to the result of the lookup
133 void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
135 /** Change old_patch to new_patch.
136 * @param old_patch the canvas patch change which is to be altered
137 * @param new_patch new patch
139 void change_patch_change (ArdourCanvas::CanvasPatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
140 void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::MusicalTime> const &);
142 void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::MusicalTime> const &);
143 void move_patch_change (ArdourCanvas::CanvasPatchChange &, Evoral::MusicalTime);
144 void delete_patch_change (ArdourCanvas::CanvasPatchChange *);
145 void edit_patch_change (ArdourCanvas::CanvasPatchChange *);
147 /** Alter a given patch to be its predecessor in the MIDNAM file.
149 void previous_patch (ArdourCanvas::CanvasPatchChange &);
151 /** Alters a given patch to be its successor in the MIDNAM file.
153 void next_patch (ArdourCanvas::CanvasPatchChange &);
155 void previous_bank (ArdourCanvas::CanvasPatchChange &);
156 void next_bank (ArdourCanvas::CanvasPatchChange &);
158 /** Displays all patch change events in the region as flags on the canvas.
160 void display_patch_changes();
162 /** Displays all system exclusive events in the region as flags on the canvas.
164 void display_sysexes();
168 void extend_active_notes();
170 void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
172 void start_note_diff_command (std::string name = "midi edit");
173 void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
174 void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
175 void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
176 void note_diff_remove_note (ArdourCanvas::CanvasNoteEvent* ev);
178 void apply_diff (bool as_subcommand = false);
179 void abort_command();
181 void note_entered(ArdourCanvas::CanvasNoteEvent* ev);
182 void note_left(ArdourCanvas::CanvasNoteEvent* ev);
183 void patch_entered (ArdourCanvas::CanvasPatchChange *);
184 void patch_left (ArdourCanvas::CanvasPatchChange *);
185 void note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
186 void unique_select(ArdourCanvas::CanvasNoteEvent* ev);
187 void note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add, bool extend=false);
188 void note_deselected(ArdourCanvas::CanvasNoteEvent* ev);
189 void delete_selection();
190 void delete_note (boost::shared_ptr<NoteType>);
191 size_t selection_size() { return _selection.size(); }
192 void select_all_notes ();
193 void select_range(framepos_t start, framepos_t end);
194 void invert_selection ();
196 void move_selection(double dx, double dy, double cumulative_dy);
197 void note_dropped (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::frameoffset_t, int8_t d_note);
199 void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
200 void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
202 /** Return true iff the note is within the extent of the region.
203 * @param visible will be set to true if the note is within the visible note range, false otherwise.
205 bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
207 /** Get the region position in pixels relative to session. */
208 double get_position_pixels();
210 /** Get the region end position in pixels relative to session. */
211 double get_end_position_pixels();
213 /** Begin resizing of some notes.
214 * Called by CanvasMidiNote when resizing starts.
215 * @param at_front which end of the note (true == note on, false == note off)
217 void begin_resizing(bool at_front);
219 void update_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
220 void commit_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
221 void abort_resizing ();
223 /** Change the channel of the selection.
224 * @param channel - the channel number of the new channel, zero-based
226 void change_channel(uint8_t channel);
233 SelectVerticalDragging,
237 MouseState mouse_state() const { return _mouse_state; }
239 struct NoteResizeData {
240 ArdourCanvas::CanvasNote *canvas_note;
241 ArdourCanvas::SimpleRect *resize_rect;
244 /** Snap a region relative pixel coordinate to pixel units.
245 * @param x a pixel coordinate relative to region start
246 * @return the snapped pixel coordinate relative to region start
248 double snap_to_pixel(double x);
250 /** Snap a region relative pixel coordinate to frame units.
251 * @param x a pixel coordinate relative to region start
252 * @return the snapped framepos_t coordinate relative to region start
254 framepos_t snap_pixel_to_frame(double x);
256 /** Convert a timestamp in beats into frames (both relative to region start) */
257 framepos_t region_beats_to_region_frames(double beats) const;
258 /** Convert a timestamp in beats into absolute frames */
259 framepos_t region_beats_to_absolute_frames(double beats) const {
260 return _region->position() + region_beats_to_region_frames (beats);
262 /** Convert a timestamp in frames to beats (both relative to region start) */
263 double region_frames_to_region_beats(framepos_t) const;
265 /** Convert a timestamp in beats measured from source start into absolute frames */
266 framepos_t source_beats_to_absolute_frames(double beats) const;
267 /** Convert a timestamp in beats measured from source start into region-relative frames */
268 framepos_t source_beats_to_region_frames(double beats) const {
269 return source_beats_to_absolute_frames (beats) - _region->position();
271 /** Convert a timestamp in absolute frames to beats measured from source start*/
272 double absolute_frames_to_source_beats(framepos_t) const;
274 void goto_previous_note (bool add_to_selection);
275 void goto_next_note (bool add_to_selection);
276 void change_note_lengths (bool, bool, Evoral::MusicalTime beats, bool start, bool end);
277 void change_velocities (bool up, bool fine, bool allow_smush);
278 void transpose (bool up, bool fine, bool allow_smush);
279 void nudge_notes (bool forward);
280 void channel_edit ();
282 void show_list_editor ();
284 void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
286 void enable_display (bool);
288 void set_channel_selector_scoped_note(ArdourCanvas::CanvasNoteEvent* note){ _channel_selection_scoped_note = note; }
289 ArdourCanvas::CanvasNoteEvent* channel_selector_scoped_note(){ return _channel_selection_scoped_note; }
291 void trim_front_starting ();
292 void trim_front_ending ();
294 void create_note_at (framepos_t, double, double, bool);
297 /** Allows derived types to specify their visibility requirements
298 * to the TimeAxisViewItem parent class.
300 MidiRegionView (ArdourCanvas::Group *,
302 boost::shared_ptr<ARDOUR::MidiRegion>,
303 double samples_per_unit,
304 Gdk::Color& basic_color,
305 TimeAxisViewItem::Visibility);
307 void region_resized (const PBD::PropertyChange&);
309 void set_flags (XMLNode *);
312 void reset_width_dependent_items (double pixel_width);
314 void parameter_changed (std::string const & p);
318 friend class MidiRubberbandSelectDrag;
319 friend class MidiVerticalSelectDrag;
321 /** Emitted when the selection has been cleared in one MidiRegionView */
322 static PBD::Signal1<void, MidiRegionView*> SelectionCleared;
323 PBD::ScopedConnection _selection_cleared_connection;
324 void selection_cleared (MidiRegionView *);
326 friend class EditNoteDialog;
328 /** Play the NoteOn event of the given note immediately
329 * and schedule the playback of the corresponding NoteOff event.
331 void play_midi_note(boost::shared_ptr<NoteType> note);
332 void play_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
334 /** Play the NoteOff-Event of the given note immediately
335 * (scheduled by @ref play_midi_note()).
337 bool play_midi_note_off(boost::shared_ptr<NoteType> note);
341 bool canvas_event(GdkEvent* ev);
342 bool note_canvas_event(GdkEvent* ev);
344 void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
345 void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
347 void change_note_channel (ArdourCanvas::CanvasNoteEvent *, int8_t, bool relative=false);
348 void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
349 void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
350 void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
351 void change_note_length (ArdourCanvas::CanvasNoteEvent *, ARDOUR::MidiModel::TimeType);
352 void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
353 ARDOUR::MidiModel::TimeType end_delta);
355 void clear_selection_except (ArdourCanvas::CanvasNoteEvent* ev, bool signal = true);
356 void clear_selection (bool signal = true) { clear_selection_except (0, signal); }
357 void update_drag_selection (double last_x, double x, double last_y, double y, bool extend);
358 void update_vertical_drag_selection (double last_y, double y, bool extend);
360 void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
361 void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
363 void show_verbose_cursor (std::string const &, double, double) const;
364 void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
366 int8_t _force_channel;
367 uint16_t _last_channel_selection;
368 uint8_t _current_range_min;
369 uint8_t _current_range_max;
371 /// MIDNAM information of the current track: Model name of MIDNAM file
372 std::string _model_name;
374 /// MIDNAM information of the current track: CustomDeviceMode
375 std::string _custom_device_mode;
377 typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
378 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasPatchChange> > PatchChanges;
379 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
381 boost::shared_ptr<ARDOUR::MidiModel> _model;
383 PatchChanges _patch_changes;
385 ArdourCanvas::CanvasNote** _active_notes;
386 ArdourCanvas::Group* _note_group;
387 ARDOUR::MidiModel::NoteDiffCommand* _note_diff_command;
388 ArdourCanvas::CanvasNote* _ghost_note;
389 double _last_ghost_x;
390 double _last_ghost_y;
391 ArdourCanvas::SimpleRect* _step_edit_cursor;
392 Evoral::MusicalTime _step_edit_cursor_width;
393 Evoral::MusicalTime _step_edit_cursor_position;
394 ArdourCanvas::CanvasNoteEvent* _channel_selection_scoped_note;
397 /** A group used to temporarily reparent _note_group to during start trims, so
398 * that the notes don't move with the parent region view.
400 ArdourCanvas::Group* _temporary_note_group;
402 MouseState _mouse_state;
405 typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
406 /// Currently selected CanvasNoteEvents
407 Selection _selection;
410 void time_sort_events ();
412 MidiCutBuffer* selection_as_cut_buffer () const;
414 /** New notes (created in the current command) which should be selected
415 * when they appear after the command is applied. */
416 std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
418 /** New notes (created in the current command) which should have visible velocity
419 * when they appear after the command is applied. */
420 std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
422 std::vector<NoteResizeData *> _resize_data;
424 /** connection used to connect to model's ContentChanged signal */
425 PBD::ScopedConnection content_connection;
427 ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
428 Events::iterator _optimization_iterator;
430 void update_note (ArdourCanvas::CanvasNote *, bool update_ghost_regions = true);
431 double update_hit (ArdourCanvas::CanvasHit *);
432 void create_ghost_note (double, double);
433 void update_ghost_note (double, double);
435 MidiListEditor* _list_editor;
436 bool _no_sound_notes;
438 PBD::ScopedConnection note_delete_connection;
439 void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
441 void snap_changed ();
442 PBD::ScopedConnection snap_changed_connection;
444 bool motion (GdkEventMotion*);
445 bool scroll (GdkEventScroll*);
446 bool key_press (GdkEventKey*);
447 bool key_release (GdkEventKey*);
448 bool button_press (GdkEventButton*);
449 bool button_release (GdkEventButton*);
450 bool enter_notify (GdkEventCrossing*);
451 bool leave_notify (GdkEventCrossing*);
453 void drop_down_keys ();
454 void maybe_select_by_position (GdkEventButton* ev, double x, double y);
455 void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
457 void display_patch_changes_on_channel (uint8_t);
459 void connect_to_diskstream ();
460 void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
462 void remove_ghost_note ();
463 void mouse_mode_changed ();
464 double _last_event_x;
465 double _last_event_y;
467 framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
469 PBD::ScopedConnection _mouse_mode_connection;
471 Gdk::Cursor* pre_enter_cursor;
472 Gdk::Cursor* pre_press_cursor;
476 #endif /* __gtk_ardour_midi_region_view_h__ */