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__
26 #include "pbd/signals.h"
28 #include "ardour/midi_model.h"
29 #include "ardour/types.h"
32 #include "region_view.h"
33 #include "midi_time_axis.h"
34 #include "time_axis_view_item.h"
35 #include "automation_line.h"
46 struct PatchPrimaryKey;
54 class MidiTimeAxisView;
56 class AutomationTimeAxisView;
57 class AutomationRegionView;
66 class MidiRegionView : public RegionView
69 typedef Evoral::Note<Evoral::MusicalTime> NoteType;
70 typedef Evoral::Sequence<Evoral::MusicalTime>::Notes Notes;
72 MidiRegionView (ArdourCanvas::Container* parent,
73 RouteTimeAxisView& tv,
74 boost::shared_ptr<ARDOUR::MidiRegion> r,
75 double samples_per_pixel,
76 uint32_t basic_color);
78 MidiRegionView (ArdourCanvas::Container* parent,
79 RouteTimeAxisView& tv,
80 boost::shared_ptr<ARDOUR::MidiRegion> r,
81 double samples_per_pixel,
84 Visibility visibility);
87 MidiRegionView (const MidiRegionView& other);
88 MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
94 const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const;
96 inline MidiTimeAxisView* midi_view() const
97 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
99 inline MidiStreamView* midi_stream_view() const
100 { return midi_view()->midi_view(); }
102 void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
103 Evoral::MusicalTime pos, Evoral::MusicalTime len);
104 void step_sustain (Evoral::MusicalTime beats);
105 void set_height (double);
106 void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
108 inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
110 uint32_t get_fill_color() const;
111 void color_handler ();
113 void show_step_edit_cursor (Evoral::MusicalTime pos);
114 void move_step_edit_cursor (Evoral::MusicalTime pos);
115 void hide_step_edit_cursor ();
116 void set_step_edit_cursor_width (Evoral::MusicalTime beats);
118 void redisplay_model();
120 GhostRegion* add_ghost (TimeAxisView&);
122 void add_note(const boost::shared_ptr<NoteType> note, bool visible);
123 void resolve_note(uint8_t note_num, Evoral::MusicalTime end_time);
125 void cut_copy_clear (Editing::CutCopyOp);
126 bool paste (framepos_t pos, const ::Selection& selection, PasteContext& ctx);
127 void paste_internal (framepos_t pos, unsigned paste_count, float times, const MidiCutBuffer&);
129 void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext, bool);
131 /** Look up the given time and channel in the 'automation' and set keys accordingly.
132 * @param time the time of the patch change event
133 * @param channel the MIDI channel of the event
134 * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
135 * will be set according to the result of the lookup
137 void get_patch_key_at (Evoral::MusicalTime time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key) const;
139 /** Convert a given PatchChange into a PatchPrimaryKey
141 MIDI::Name::PatchPrimaryKey patch_change_to_patch_key (ARDOUR::MidiModel::PatchChangePtr);
143 /** Change old_patch to new_patch.
144 * @param old_patch the canvas patch change which is to be altered
145 * @param new_patch new patch
147 void change_patch_change (PatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
148 void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::MusicalTime> const &);
150 void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::MusicalTime> const &);
151 void move_patch_change (PatchChange &, Evoral::MusicalTime);
152 void delete_patch_change (PatchChange *);
153 void edit_patch_change (PatchChange *);
155 void delete_sysex (SysEx*);
157 /** Change a patch to the next or previous bank/program.
158 * @param bank If true, step bank, otherwise, step program.
159 * @param delta Amount to adjust number.
161 void step_patch (PatchChange& patch, bool bank, int delta);
163 /** Displays all patch change events in the region as flags on the canvas.
165 void display_patch_changes();
167 /** Displays all system exclusive events in the region as flags on the canvas.
169 void display_sysexes();
173 void extend_active_notes();
175 void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
177 void start_note_diff_command (std::string name = "midi edit");
178 void note_diff_add_change (NoteBase* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
179 void note_diff_add_change (NoteBase* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
180 void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
181 void note_diff_remove_note (NoteBase* ev);
183 void apply_diff (bool as_subcommand = false);
184 void abort_command();
186 void note_entered(NoteBase* ev);
187 void note_left(NoteBase* ev);
188 void patch_entered (PatchChange *);
189 void patch_left (PatchChange *);
190 void sysex_entered (SysEx* p);
191 void sysex_left (SysEx* p);
192 void note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
193 void unique_select(NoteBase* ev);
194 void note_selected(NoteBase* ev, bool add, bool extend=false);
195 void note_deselected(NoteBase* ev);
196 void delete_selection();
197 void delete_note (boost::shared_ptr<NoteType>);
198 size_t selection_size() { return _selection.size(); }
199 void select_all_notes ();
200 void select_range(framepos_t start, framepos_t end);
201 void invert_selection ();
203 void move_selection(double dx, double dy, double cumulative_dy);
204 void note_dropped (NoteBase* ev, ARDOUR::frameoffset_t, int8_t d_note);
206 void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
207 void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
209 /** Return true iff the note is within the extent of the region.
210 * @param visible will be set to true if the note is within the visible note range, false otherwise.
212 bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
214 /** Get the region position in pixels relative to session. */
215 double get_position_pixels();
217 /** Get the region end position in pixels relative to session. */
218 double get_end_position_pixels();
220 /** Begin resizing of some notes.
221 * Called by CanvasMidiNote when resizing starts.
222 * @param at_front which end of the note (true == note on, false == note off)
224 void begin_resizing(bool at_front);
226 void update_resizing (NoteBase*, bool, double, bool);
227 void commit_resizing (NoteBase*, bool, double, bool);
228 void abort_resizing ();
230 /** Change the channel of the selection.
231 * @param channel - the channel number of the new channel, zero-based
233 void change_channel(uint8_t channel);
240 SelectVerticalDragging,
244 MouseState mouse_state() const { return _mouse_state; }
246 void note_button_release ();
248 struct NoteResizeData {
250 ArdourCanvas::Rectangle *resize_rect;
253 /** Snap a region relative pixel coordinate to pixel units.
254 * @param x a pixel coordinate relative to region start
255 * @return the snapped pixel coordinate relative to region start
257 double snap_to_pixel(double x);
259 /** Snap a region relative pixel coordinate to frame units.
260 * @param x a pixel coordinate relative to region start
261 * @return the snapped framepos_t coordinate relative to region start
263 framepos_t snap_pixel_to_sample(double x);
265 /** Convert a timestamp in beats into frames (both relative to region position) */
266 framepos_t region_beats_to_region_frames(Evoral::MusicalTime beats) const;
267 /** Convert a timestamp in beats into absolute frames */
268 framepos_t region_beats_to_absolute_frames(Evoral::MusicalTime beats) const {
269 return _region->position() + region_beats_to_region_frames (beats);
271 /** Convert a timestamp in frames to beats (both relative to region position) */
272 Evoral::MusicalTime region_frames_to_region_beats(framepos_t) const;
274 /** Convert a timestamp in beats measured from source start into absolute frames */
275 framepos_t source_beats_to_absolute_frames(Evoral::MusicalTime beats) const;
276 /** Convert a timestamp in beats measured from source start into region-relative frames */
277 framepos_t source_beats_to_region_frames(Evoral::MusicalTime beats) const {
278 return source_beats_to_absolute_frames (beats) - _region->position();
280 /** Convert a timestamp in absolute frames to beats measured from source start*/
281 Evoral::MusicalTime absolute_frames_to_source_beats(framepos_t) const;
283 ARDOUR::BeatsFramesConverter const & region_relative_time_converter () const {
284 return _region_relative_time_converter;
287 ARDOUR::BeatsFramesConverter const & source_relative_time_converter () const {
288 return _source_relative_time_converter;
291 void goto_previous_note (bool add_to_selection);
292 void goto_next_note (bool add_to_selection);
293 void change_note_lengths (bool, bool, Evoral::MusicalTime beats, bool start, bool end);
294 void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
295 void transpose (bool up, bool fine, bool allow_smush);
296 void nudge_notes (bool forward, bool fine);
297 void channel_edit ();
298 void velocity_edit ();
300 void show_list_editor ();
302 typedef std::set<NoteBase*> Selection;
303 Selection selection () const {
307 void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
309 void enable_display (bool);
311 void set_channel_selector_scoped_note(NoteBase* note){ _channel_selection_scoped_note = note; }
312 NoteBase* channel_selector_scoped_note(){ return _channel_selection_scoped_note; }
314 void trim_front_starting ();
315 void trim_front_ending ();
317 /** Add a note to the model, and the view, at a canvas (click) coordinate.
318 * \param t time in frames relative to the position of the region
319 * \param y vertical position in pixels
320 * \param length duration of the note in beats
321 * \param snap_t true to snap t to the grid, otherwise false.
323 void create_note_at (framepos_t t, double y, Evoral::MusicalTime length, bool snap_t);
325 void clear_selection (bool signal = true) { clear_selection_except (0, signal); }
327 ARDOUR::InstrumentInfo& instrument_info() const;
330 void region_resized (const PBD::PropertyChange&);
332 void set_flags (XMLNode *);
335 void reset_width_dependent_items (double pixel_width);
337 void parameter_changed (std::string const & p);
341 friend class MidiRubberbandSelectDrag;
342 friend class MidiVerticalSelectDrag;
344 /** Emitted when the selection has been cleared in one MidiRegionView,
345 * with the expectation that others will clear their selections in
348 static PBD::Signal1<void, MidiRegionView*> SelectionCleared;
349 PBD::ScopedConnection _selection_cleared_connection;
350 void selection_cleared (MidiRegionView *);
352 /** this handles the case when the "external" world wants us to clear our internal selections
354 PBD::ScopedConnection _clear_midi_selection_connection;
355 void clear_midi_selection () { clear_selection(); }
357 friend class EditNoteDialog;
359 /** Play the NoteOn event of the given note immediately
360 * and schedule the playback of the corresponding NoteOff event.
362 void play_midi_note (boost::shared_ptr<NoteType> note);
363 void start_playing_midi_note (boost::shared_ptr<NoteType> note);
364 void start_playing_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
366 void clear_events (bool with_selection_signal = true);
368 bool canvas_group_event(GdkEvent* ev);
369 bool note_canvas_event(GdkEvent* ev);
371 void midi_channel_mode_changed ();
372 PBD::ScopedConnection _channel_mode_changed_connection;
373 void instrument_settings_changed ();
374 PBD::ScopedConnection _instrument_changed_connection;
376 void change_note_channel (NoteBase *, int8_t, bool relative=false);
377 void change_note_velocity(NoteBase* ev, int8_t vel, bool relative=false);
378 void change_note_note(NoteBase* ev, int8_t note, bool relative=false);
379 void change_note_time(NoteBase* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
380 void change_note_length (NoteBase *, ARDOUR::MidiModel::TimeType);
381 void trim_note(NoteBase* ev, ARDOUR::MidiModel::TimeType start_delta,
382 ARDOUR::MidiModel::TimeType end_delta);
384 void clear_selection_except (NoteBase* ev, bool signal = true);
385 void update_drag_selection (framepos_t start, framepos_t end, double y0, double y1, bool extend);
386 void update_vertical_drag_selection (double last_y, double y, bool extend);
388 void add_to_selection (NoteBase*);
389 void remove_from_selection (NoteBase*);
391 void show_verbose_cursor (std::string const &, double, double) const;
392 void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
394 uint8_t _current_range_min;
395 uint8_t _current_range_max;
397 typedef std::list<NoteBase*> Events;
398 typedef std::vector< boost::shared_ptr<PatchChange> > PatchChanges;
399 typedef std::vector< boost::shared_ptr<SysEx> > SysExes;
401 ARDOUR::BeatsFramesConverter _region_relative_time_converter;
402 ARDOUR::BeatsFramesConverter _source_relative_time_converter;
404 boost::shared_ptr<ARDOUR::MidiModel> _model;
406 PatchChanges _patch_changes;
408 Note** _active_notes;
409 ArdourCanvas::Container* _note_group;
410 ARDOUR::MidiModel::NoteDiffCommand* _note_diff_command;
412 double _last_ghost_x;
413 double _last_ghost_y;
414 ArdourCanvas::Rectangle* _step_edit_cursor;
415 Evoral::MusicalTime _step_edit_cursor_width;
416 Evoral::MusicalTime _step_edit_cursor_position;
417 NoteBase* _channel_selection_scoped_note;
419 /** A group used to temporarily reparent _note_group to during start trims, so
420 * that the notes don't move with the parent region view.
422 ArdourCanvas::Container* _temporary_note_group;
424 MouseState _mouse_state;
427 /** Currently selected NoteBase objects */
428 Selection _selection;
431 void time_sort_events ();
433 MidiCutBuffer* selection_as_cut_buffer () const;
435 /** New notes (created in the current command) which should be selected
436 * when they appear after the command is applied. */
437 std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
439 /** New notes (created in the current command) which should have visible velocity
440 * when they appear after the command is applied. */
441 std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
443 std::vector<NoteResizeData *> _resize_data;
445 /** connection used to connect to model's ContentChanged signal */
446 PBD::ScopedConnection content_connection;
448 NoteBase* find_canvas_note (boost::shared_ptr<NoteType>);
449 Events::iterator _optimization_iterator;
451 void update_note (Note *, bool update_ghost_regions = true);
452 void update_hit (Hit *);
453 void create_ghost_note (double, double);
454 void update_ghost_note (double, double);
456 MidiListEditor* _list_editor;
457 bool _no_sound_notes;
459 PBD::ScopedConnection note_delete_connection;
460 void maybe_remove_deleted_note_from_selection (NoteBase*);
462 void snap_changed ();
463 PBD::ScopedConnection snap_changed_connection;
465 bool motion (GdkEventMotion*);
466 bool scroll (GdkEventScroll*);
467 bool key_press (GdkEventKey*);
468 bool key_release (GdkEventKey*);
469 bool button_press (GdkEventButton*);
470 bool button_release (GdkEventButton*);
471 bool enter_notify (GdkEventCrossing*);
472 bool leave_notify (GdkEventCrossing*);
474 void drop_down_keys ();
475 void maybe_select_by_position (GdkEventButton* ev, double x, double y);
476 void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
478 void display_patch_changes_on_channel (uint8_t, bool);
480 void connect_to_diskstream ();
481 void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
483 /** Get grid type as beats, or default to 1 if not snapped to beats. */
484 Evoral::MusicalTime get_grid_beats(framepos_t pos) const;
486 void remove_ghost_note ();
487 void mouse_mode_changed ();
488 void enter_internal ();
489 void leave_internal ();
491 double _last_event_x;
492 double _last_event_y;
493 bool _grabbed_keyboard;
496 framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
498 PBD::ScopedConnection _mouse_mode_connection;
500 boost::shared_ptr<CursorContext> _press_cursor_ctx;
502 NotePlayer* _note_player;
504 ARDOUR::ChannelMode get_channel_mode() const;
505 uint16_t get_selected_channels () const;
509 #endif /* __gtk_ardour_midi_region_view_h__ */