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_region.h"
32 #include "ardour/midi_model.h"
33 #include "ardour/diskstream.h"
34 #include "ardour/types.h"
37 #include "region_view.h"
38 #include "midi_time_axis.h"
39 #include "time_axis_view_item.h"
40 #include "automation_line.h"
43 #include "canvas-hit.h"
44 #include "canvas-note.h"
45 #include "canvas-note-event.h"
46 #include "canvas_patch_change.h"
47 #include "canvas-sysex.h"
57 struct PatchPrimaryKey;
61 class MidiTimeAxisView;
63 class AutomationTimeAxisView;
64 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 inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
89 { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
91 inline MidiTimeAxisView* midi_view() const
92 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
94 inline MidiStreamView* midi_stream_view() const
95 { return midi_view()->midi_view(); }
97 void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
98 Evoral::MusicalTime pos, Evoral::MusicalTime len);
99 void step_sustain (Evoral::MusicalTime beats);
100 void set_height (double);
101 void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
103 inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
105 void set_frame_color();
106 void color_handler ();
108 void show_step_edit_cursor (Evoral::MusicalTime pos);
109 void move_step_edit_cursor (Evoral::MusicalTime pos);
110 void hide_step_edit_cursor ();
111 void set_step_edit_cursor_width (Evoral::MusicalTime beats);
113 void redisplay_model();
115 GhostRegion* add_ghost (TimeAxisView&);
117 void add_note(const boost::shared_ptr<NoteType> note, bool visible);
118 void resolve_note(uint8_t note_num, double end_time);
120 void cut_copy_clear (Editing::CutCopyOp);
121 void paste (framepos_t pos, float times, const MidiCutBuffer&);
123 /** Add a new patch change flag to the canvas.
124 * @param patch the patch change to add
125 * @param the text to display in the flag
127 void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext);
129 /** Look up the given time and channel in the 'automation' and set keys accordingly.
130 * @param time the time of the patch change event
131 * @param channel the MIDI channel of the event
132 * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
133 * will be set according to the result of the lookup
135 void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
137 /** Change old_patch to new_patch.
138 * @param old_patch the canvas patch change which is to be altered
139 * @param new_patch new patch
141 void change_patch_change (ArdourCanvas::CanvasPatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
142 void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::MusicalTime> const &);
144 void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::MusicalTime> const &);
145 void move_patch_change (ArdourCanvas::CanvasPatchChange &, Evoral::MusicalTime);
146 void delete_patch_change (ArdourCanvas::CanvasPatchChange *);
147 void edit_patch_change (ArdourCanvas::CanvasPatchChange *);
149 /** Alter a given patch to be its predecessor in the MIDNAM file.
151 void previous_patch (ArdourCanvas::CanvasPatchChange &);
153 /** Alters a given patch to be its successor in the MIDNAM file.
155 void next_patch (ArdourCanvas::CanvasPatchChange &);
157 void previous_bank (ArdourCanvas::CanvasPatchChange &);
158 void next_bank (ArdourCanvas::CanvasPatchChange &);
160 /** Displays all patch change events in the region as flags on the canvas.
162 void display_patch_changes();
164 /** Displays all system exclusive events in the region as flags on the canvas.
166 void display_sysexes();
170 void extend_active_notes();
172 void create_note_at(double x, double y, double length, bool);
174 void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
176 void start_note_diff_command (std::string name = "midi edit");
177 void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
178 void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
179 void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
180 void note_diff_remove_note (ArdourCanvas::CanvasNoteEvent* ev);
182 void apply_diff (bool as_subcommand = false);
183 void abort_command();
185 void note_entered(ArdourCanvas::CanvasNoteEvent* ev);
186 void note_left(ArdourCanvas::CanvasNoteEvent* ev);
187 void patch_entered (ArdourCanvas::CanvasPatchChange *);
188 void patch_left (ArdourCanvas::CanvasPatchChange *);
189 void note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
190 void unique_select(ArdourCanvas::CanvasNoteEvent* ev);
191 void note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add, bool extend=false);
192 void note_deselected(ArdourCanvas::CanvasNoteEvent* ev);
193 void delete_selection();
194 void delete_note (boost::shared_ptr<NoteType>);
195 size_t selection_size() { return _selection.size(); }
196 void select_all_notes ();
198 void move_selection(double dx, double dy, double cumulative_dy);
199 void note_dropped (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::frameoffset_t, int8_t d_note);
201 void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
202 void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
204 /** Return true iff the note is within the extent of the region.
205 * @param visible will be set to true if the note is within the visible note range, false otherwise.
207 bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
209 /** Get the region position in pixels relative to session. */
210 double get_position_pixels();
212 /** Get the region end position in pixels relative to session. */
213 double get_end_position_pixels();
215 /** Begin resizing of some notes.
216 * Called by CanvasMidiNote when resizing starts.
217 * @param at_front which end of the note (true == note on, false == note off)
219 void begin_resizing(bool at_front);
221 void update_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
222 void commit_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
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);
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 ARDOUR::frameoffset_t snap_frame_to_frame (ARDOUR::frameoffset_t);
258 /** Convert a timestamp in beats into frames (both relative to region start) */
259 framepos_t region_beats_to_region_frames(double beats) const;
260 /** Convert a timestamp in beats into absolute frames */
261 framepos_t region_beats_to_absolute_frames(double beats) const {
262 return _region->position() + region_beats_to_region_frames (beats);
264 /** Convert a timestamp in frames to beats (both relative to region start) */
265 double region_frames_to_region_beats(framepos_t) const;
267 /** Convert a timestamp in beats measured from source start into absolute frames */
268 framepos_t source_beats_to_absolute_frames(double beats) const;
269 /** Convert a timestamp in beats measured from source start into region-relative frames */
270 framepos_t source_beats_to_region_frames(double beats) const {
271 return source_beats_to_absolute_frames (beats) - _region->position();
273 /** Convert a timestamp in absolute frames to beats measured from source start*/
274 double absolute_frames_to_source_beats(framepos_t) const;
276 void goto_previous_note (bool add_to_selection);
277 void goto_next_note (bool add_to_selection);
278 void change_note_lengths (bool, bool, Evoral::MusicalTime beats, bool start, bool end);
279 void change_velocities (bool up, bool fine, bool allow_smush);
280 void transpose (bool up, bool fine, bool allow_smush);
281 void nudge_notes (bool forward);
282 void channel_edit ();
284 void show_list_editor ();
286 void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
288 void enable_display (bool);
290 void set_channel_selector_scoped_note(ArdourCanvas::CanvasNoteEvent* note){ _channel_selection_scoped_note = note; }
291 ArdourCanvas::CanvasNoteEvent* channel_selector_scoped_note(){ return _channel_selection_scoped_note; }
293 void trim_front_starting ();
294 void trim_front_ending ();
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 EditNoteDialog;
320 /** Play the NoteOn event of the given note immediately
321 * and schedule the playback of the corresponding NoteOff event.
323 void play_midi_note(boost::shared_ptr<NoteType> note);
324 void play_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
326 /** Play the NoteOff-Event of the given note immediately
327 * (scheduled by @ref play_midi_note()).
329 bool play_midi_note_off(boost::shared_ptr<NoteType> note);
333 bool canvas_event(GdkEvent* ev);
334 bool note_canvas_event(GdkEvent* ev);
336 void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
337 void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
339 void change_note_channel (ArdourCanvas::CanvasNoteEvent *, int8_t, bool relative=false);
340 void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
341 void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
342 void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
343 void change_note_length (ArdourCanvas::CanvasNoteEvent *, ARDOUR::MidiModel::TimeType);
344 void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
345 ARDOUR::MidiModel::TimeType end_delta);
347 void clear_selection_except (ArdourCanvas::CanvasNoteEvent* ev);
348 void clear_selection() { clear_selection_except (0); }
349 void update_drag_selection (double last_x, double x, double last_y, double y, bool extend);
351 void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
352 void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
354 void show_verbose_cursor (std::string const &, double, double) const;
355 void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
357 int8_t _force_channel;
358 uint16_t _last_channel_selection;
359 uint8_t _current_range_min;
360 uint8_t _current_range_max;
362 /// MIDNAM information of the current track: Model name of MIDNAM file
363 std::string _model_name;
365 /// MIDNAM information of the current track: CustomDeviceMode
366 std::string _custom_device_mode;
368 typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
369 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasPatchChange> > PatchChanges;
370 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
372 boost::shared_ptr<ARDOUR::MidiModel> _model;
374 PatchChanges _patch_changes;
376 ArdourCanvas::CanvasNote** _active_notes;
377 ArdourCanvas::Group* _note_group;
378 ARDOUR::MidiModel::NoteDiffCommand* _note_diff_command;
379 ArdourCanvas::CanvasNote* _ghost_note;
380 double _last_ghost_x;
381 double _last_ghost_y;
382 double _drag_start_x;
383 double _drag_start_y;
386 ArdourCanvas::SimpleRect* _drag_rect;
387 ArdourCanvas::SimpleRect* _step_edit_cursor;
388 Evoral::MusicalTime _step_edit_cursor_width;
389 Evoral::MusicalTime _step_edit_cursor_position;
390 ArdourCanvas::CanvasNoteEvent* _channel_selection_scoped_note;
393 /** A group used to temporarily reparent _note_group to during start trims, so
394 * that the notes don't move with the parent region view.
396 ArdourCanvas::Group* _temporary_note_group;
398 MouseState _mouse_state;
401 typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
402 /// Currently selected CanvasNoteEvents
403 Selection _selection;
406 void time_sort_events ();
408 MidiCutBuffer* selection_as_cut_buffer () const;
410 /** New notes (created in the current command) which should be selected
411 * when they appear after the command is applied. */
412 std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
414 /** New notes (created in the current command) which should have visible velocity
415 * when they appear after the command is applied. */
416 std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
418 std::vector<NoteResizeData *> _resize_data;
420 /** connection used to connect to model's ContentChanged signal */
421 PBD::ScopedConnection content_connection;
423 ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
424 Events::iterator _optimization_iterator;
426 void update_note (ArdourCanvas::CanvasNote *, bool update_ghost_regions = true);
427 double update_hit (ArdourCanvas::CanvasHit *);
428 void create_ghost_note (double, double);
429 void update_ghost_note (double, double);
431 MidiListEditor* _list_editor;
432 bool _no_sound_notes;
434 PBD::ScopedConnection note_delete_connection;
435 void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
437 void snap_changed ();
438 PBD::ScopedConnection snap_changed_connection;
440 bool motion (GdkEventMotion*);
441 bool scroll (GdkEventScroll*);
442 bool key_press (GdkEventKey*);
443 bool key_release (GdkEventKey*);
444 bool button_press (GdkEventButton*);
445 bool button_release (GdkEventButton*);
446 bool enter_notify (GdkEventCrossing*);
447 bool leave_notify (GdkEventCrossing*);
449 void drop_down_keys ();
450 void maybe_select_by_position (GdkEventButton* ev, double x, double y);
451 void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
453 void display_patch_changes_on_channel (uint8_t);
455 void connect_to_diskstream ();
456 void data_recorded (boost::shared_ptr<ARDOUR::MidiBuffer>, boost::weak_ptr<ARDOUR::MidiSource>);
458 void remove_ghost_note ();
459 void mouse_mode_changed ();
460 double _last_event_x;
461 double _last_event_y;
463 PBD::ScopedConnection _mouse_mode_connection;
465 Gdk::Cursor* _pre_enter_cursor;
469 #endif /* __gtk_ardour_midi_region_view_h__ */