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_model.h"
31 #include "ardour/types.h"
34 #include "region_view.h"
35 #include "midi_time_axis.h"
36 #include "time_axis_view_item.h"
37 #include "automation_line.h"
40 #include "canvas-hit.h"
41 #include "canvas-note.h"
42 #include "canvas-note-event.h"
43 #include "canvas_patch_change.h"
44 #include "canvas-sysex.h"
54 struct PatchPrimaryKey;
58 class MidiTimeAxisView;
60 class AutomationTimeAxisView;
61 class AutomationRegionView;
67 class MidiRegionView : public RegionView
70 typedef Evoral::Note<Evoral::MusicalTime> NoteType;
71 typedef Evoral::Sequence<Evoral::MusicalTime>::Notes Notes;
73 MidiRegionView (ArdourCanvas::Group *,
75 boost::shared_ptr<ARDOUR::MidiRegion>,
76 double initial_samples_per_unit,
77 Gdk::Color const & basic_color);
79 MidiRegionView (const MidiRegionView& other);
80 MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
84 virtual void init (Gdk::Color const & basic_color, bool wfd);
86 const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const;
88 inline MidiTimeAxisView* midi_view() const
89 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
91 inline MidiStreamView* midi_stream_view() const
92 { return midi_view()->midi_view(); }
94 void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
95 Evoral::MusicalTime pos, Evoral::MusicalTime len);
96 void step_sustain (Evoral::MusicalTime beats);
97 void set_height (double);
98 void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
100 inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
102 void set_frame_color();
103 void color_handler ();
105 void show_step_edit_cursor (Evoral::MusicalTime pos);
106 void move_step_edit_cursor (Evoral::MusicalTime pos);
107 void hide_step_edit_cursor ();
108 void set_step_edit_cursor_width (Evoral::MusicalTime beats);
110 void redisplay_model();
112 GhostRegion* add_ghost (TimeAxisView&);
114 void add_note(const boost::shared_ptr<NoteType> note, bool visible);
115 void resolve_note(uint8_t note_num, double end_time);
117 void cut_copy_clear (Editing::CutCopyOp);
118 void paste (framepos_t pos, float times, const MidiCutBuffer&);
120 void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext, bool);
122 /** Look up the given time and channel in the 'automation' and set keys accordingly.
123 * @param time the time of the patch change event
124 * @param channel the MIDI channel of the event
125 * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
126 * will be set according to the result of the lookup
128 void get_patch_key_at (double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key) const;
130 /** Convert a given PatchChange into a PatchPrimaryKey
132 MIDI::Name::PatchPrimaryKey patch_change_to_patch_key (ARDOUR::MidiModel::PatchChangePtr);
134 /** Change old_patch to new_patch.
135 * @param old_patch the canvas patch change which is to be altered
136 * @param new_patch new patch
138 void change_patch_change (ArdourCanvas::CanvasPatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
139 void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::MusicalTime> const &);
141 void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::MusicalTime> const &);
142 void move_patch_change (ArdourCanvas::CanvasPatchChange &, Evoral::MusicalTime);
143 void delete_patch_change (ArdourCanvas::CanvasPatchChange *);
144 void edit_patch_change (ArdourCanvas::CanvasPatchChange *);
146 void delete_sysex (ArdourCanvas::CanvasSysEx*);
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 sysex_entered (ArdourCanvas::CanvasSysEx* p);
187 void sysex_left (ArdourCanvas::CanvasSysEx* p);
188 void note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
189 void unique_select(ArdourCanvas::CanvasNoteEvent* ev);
190 void note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add, bool extend=false);
191 void note_deselected(ArdourCanvas::CanvasNoteEvent* ev);
192 void delete_selection();
193 void delete_note (boost::shared_ptr<NoteType>);
194 size_t selection_size() { return _selection.size(); }
195 void select_all_notes ();
196 void select_range(framepos_t start, framepos_t end);
197 void invert_selection ();
199 void move_selection(double dx, double dy, double cumulative_dy);
200 void note_dropped (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::frameoffset_t, int8_t d_note);
202 void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
203 void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
205 /** Return true iff the note is within the extent of the region.
206 * @param visible will be set to true if the note is within the visible note range, false otherwise.
208 bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
210 /** Get the region position in pixels relative to session. */
211 double get_position_pixels();
213 /** Get the region end position in pixels relative to session. */
214 double get_end_position_pixels();
216 /** Begin resizing of some notes.
217 * Called by CanvasMidiNote when resizing starts.
218 * @param at_front which end of the note (true == note on, false == note off)
220 void begin_resizing(bool at_front);
222 void update_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
223 void commit_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
224 void abort_resizing ();
226 /** Change the channel of the selection.
227 * @param channel - the channel number of the new channel, zero-based
229 void change_channel(uint8_t channel);
236 SelectVerticalDragging,
240 MouseState mouse_state() const { return _mouse_state; }
242 void note_button_release ();
244 struct NoteResizeData {
245 ArdourCanvas::CanvasNote *canvas_note;
246 ArdourCanvas::SimpleRect *resize_rect;
249 /** Snap a region relative pixel coordinate to pixel units.
250 * @param x a pixel coordinate relative to region start
251 * @return the snapped pixel coordinate relative to region start
253 double snap_to_pixel(double x);
255 /** Snap a region relative pixel coordinate to frame units.
256 * @param x a pixel coordinate relative to region start
257 * @return the snapped framepos_t coordinate relative to region start
259 framepos_t snap_pixel_to_frame(double x);
261 /** Convert a timestamp in beats into frames (both relative to region position) */
262 framepos_t region_beats_to_region_frames(double beats) const;
263 /** Convert a timestamp in beats into absolute frames */
264 framepos_t region_beats_to_absolute_frames(double beats) const {
265 return _region->position() + region_beats_to_region_frames (beats);
267 /** Convert a timestamp in frames to beats (both relative to region position) */
268 double region_frames_to_region_beats(framepos_t) const;
270 /** Convert a timestamp in beats measured from source start into absolute frames */
271 framepos_t source_beats_to_absolute_frames(double beats) const;
272 /** Convert a timestamp in beats measured from source start into region-relative frames */
273 framepos_t source_beats_to_region_frames(double beats) const {
274 return source_beats_to_absolute_frames (beats) - _region->position();
276 /** Convert a timestamp in absolute frames to beats measured from source start*/
277 double absolute_frames_to_source_beats(framepos_t) const;
279 void goto_previous_note (bool add_to_selection);
280 void goto_next_note (bool add_to_selection);
281 void change_note_lengths (bool, bool, Evoral::MusicalTime beats, bool start, bool end);
282 void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
283 void transpose (bool up, bool fine, bool allow_smush);
284 void nudge_notes (bool forward);
285 void channel_edit ();
286 void velocity_edit ();
288 void show_list_editor ();
290 typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
291 Selection selection () const {
295 void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
297 void enable_display (bool);
299 void set_channel_selector_scoped_note(ArdourCanvas::CanvasNoteEvent* note){ _channel_selection_scoped_note = note; }
300 ArdourCanvas::CanvasNoteEvent* channel_selector_scoped_note(){ return _channel_selection_scoped_note; }
302 void trim_front_starting ();
303 void trim_front_ending ();
305 void create_note_at (framepos_t, double, double, bool);
307 void clear_selection (bool signal = true) { clear_selection_except (0, signal); }
309 ARDOUR::InstrumentInfo& instrument_info() const;
312 /** Allows derived types to specify their visibility requirements
313 * to the TimeAxisViewItem parent class.
315 MidiRegionView (ArdourCanvas::Group *,
317 boost::shared_ptr<ARDOUR::MidiRegion>,
318 double samples_per_unit,
319 Gdk::Color& basic_color,
320 TimeAxisViewItem::Visibility);
322 void region_resized (const PBD::PropertyChange&);
324 void set_flags (XMLNode *);
327 void reset_width_dependent_items (double pixel_width);
329 void parameter_changed (std::string const & p);
333 friend class MidiRubberbandSelectDrag;
334 friend class MidiVerticalSelectDrag;
336 /** Emitted when the selection has been cleared in one MidiRegionView,
337 * with the expectation that others will clear their selections in
340 static PBD::Signal1<void, MidiRegionView*> SelectionCleared;
341 PBD::ScopedConnection _selection_cleared_connection;
342 void selection_cleared (MidiRegionView *);
344 friend class EditNoteDialog;
346 /** Play the NoteOn event of the given note immediately
347 * and schedule the playback of the corresponding NoteOff event.
349 void play_midi_note (boost::shared_ptr<NoteType> note);
350 void start_playing_midi_note (boost::shared_ptr<NoteType> note);
351 void start_playing_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
353 void clear_events (bool with_selection_signal = true);
355 bool canvas_event(GdkEvent* ev);
356 bool note_canvas_event(GdkEvent* ev);
358 void midi_channel_mode_changed ();
359 PBD::ScopedConnection _channel_mode_changed_connection;
360 void instrument_settings_changed ();
361 PBD::ScopedConnection _instrument_changed_connection;
363 void change_note_channel (ArdourCanvas::CanvasNoteEvent *, int8_t, bool relative=false);
364 void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
365 void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
366 void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
367 void change_note_length (ArdourCanvas::CanvasNoteEvent *, ARDOUR::MidiModel::TimeType);
368 void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
369 ARDOUR::MidiModel::TimeType end_delta);
371 void clear_selection_except (ArdourCanvas::CanvasNoteEvent* ev, bool signal = true);
372 void update_drag_selection (double last_x, double x, double last_y, double y, bool extend);
373 void update_vertical_drag_selection (double last_y, double y, bool extend);
375 void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
376 void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
378 void show_verbose_cursor (std::string const &, double, double) const;
379 void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
381 uint8_t _current_range_min;
382 uint8_t _current_range_max;
384 typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
385 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasPatchChange> > PatchChanges;
386 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
388 boost::shared_ptr<ARDOUR::MidiModel> _model;
390 PatchChanges _patch_changes;
392 ArdourCanvas::CanvasNote** _active_notes;
393 ArdourCanvas::Group* _note_group;
394 ARDOUR::MidiModel::NoteDiffCommand* _note_diff_command;
395 ArdourCanvas::CanvasNote* _ghost_note;
396 double _last_ghost_x;
397 double _last_ghost_y;
398 ArdourCanvas::SimpleRect* _step_edit_cursor;
399 Evoral::MusicalTime _step_edit_cursor_width;
400 Evoral::MusicalTime _step_edit_cursor_position;
401 ArdourCanvas::CanvasNoteEvent* _channel_selection_scoped_note;
404 /** A group used to temporarily reparent _note_group to during start trims, so
405 * that the notes don't move with the parent region view.
407 ArdourCanvas::Group* _temporary_note_group;
409 MouseState _mouse_state;
412 /** Currently selected CanvasNoteEvents */
413 Selection _selection;
416 void time_sort_events ();
418 MidiCutBuffer* selection_as_cut_buffer () const;
420 /** New notes (created in the current command) which should be selected
421 * when they appear after the command is applied. */
422 std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
424 /** New notes (created in the current command) which should have visible velocity
425 * when they appear after the command is applied. */
426 std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
428 std::vector<NoteResizeData *> _resize_data;
430 /** connection used to connect to model's ContentChanged signal */
431 PBD::ScopedConnection content_connection;
433 ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
434 Events::iterator _optimization_iterator;
436 void update_note (ArdourCanvas::CanvasNote *, bool update_ghost_regions = true);
437 double update_hit (ArdourCanvas::CanvasHit *);
438 void create_ghost_note (double, double);
439 void update_ghost_note (double, double);
441 MidiListEditor* _list_editor;
442 bool _no_sound_notes;
444 PBD::ScopedConnection note_delete_connection;
445 void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
447 void snap_changed ();
448 PBD::ScopedConnection snap_changed_connection;
450 bool motion (GdkEventMotion*);
451 bool scroll (GdkEventScroll*);
452 bool key_press (GdkEventKey*);
453 bool key_release (GdkEventKey*);
454 bool button_press (GdkEventButton*);
455 bool button_release (GdkEventButton*);
456 bool enter_notify (GdkEventCrossing*);
457 bool leave_notify (GdkEventCrossing*);
459 void drop_down_keys ();
460 void maybe_select_by_position (GdkEventButton* ev, double x, double y);
461 void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
463 void display_patch_changes_on_channel (uint8_t, bool);
465 void connect_to_diskstream ();
466 void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
468 void remove_ghost_note ();
469 void mouse_mode_changed ();
470 double _last_event_x;
471 double _last_event_y;
473 framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
475 PBD::ScopedConnection _mouse_mode_connection;
477 Gdk::Cursor* pre_enter_cursor;
478 Gdk::Cursor* pre_press_cursor;
480 NotePlayer* _note_player;
482 ARDOUR::ChannelMode get_channel_mode() const;
483 uint16_t get_selected_channels () const;
487 #endif /* __gtk_ardour_midi_region_view_h__ */