2 Copyright (C) 2001-2010 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-program-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&);
124 PCEvent(double a_time, uint8_t a_value, uint8_t a_channel)
125 : time(a_time), value(a_value), channel(a_channel) {}
132 /** Add a new program change flag to the canvas.
133 * @param program the MidiRegionView::PCEvent to add
134 * @param the text to display in the flag
136 void add_canvas_program_change (PCEvent& program, const std::string& displaytext);
138 /** Look up the given time and channel in the 'automation' and set keys accordingly.
139 * @param time the time of the program change event
140 * @param channel the MIDI channel of the event
141 * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
142 * will be set according to the result of the lookup
144 void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
146 /** Change the 'automation' data of old_program to new values which correspond to new_patch.
147 * @param old_program the program change event which is to be altered
148 * @param new_patch the new lsb, msb and program number which are to be set
150 void alter_program_change(PCEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
152 void add_program_change (framecnt_t, uint8_t, uint8_t);
153 void move_program_change (PCEvent, Evoral::MusicalTime);
154 void delete_program_change (ArdourCanvas::CanvasProgramChange *);
156 /** Alter a given program to the new given one.
157 * (Called on context menu select on CanvasProgramChange)
159 void program_selected(
160 ArdourCanvas::CanvasProgramChange& program,
161 const MIDI::Name::PatchPrimaryKey& new_patch);
163 /** Alter a given program to be its predecessor in the MIDNAM file.
165 void previous_program(ArdourCanvas::CanvasProgramChange& program);
167 /** Alters a given program to be its successor in the MIDNAM file.
169 void next_program(ArdourCanvas::CanvasProgramChange& program);
171 /** Displays all program change events in the region as flags on the canvas.
173 void display_program_changes();
175 /** Displays all system exclusive events in the region as flags on the canvas.
177 void display_sysexes();
181 void extend_active_notes();
183 void create_note_at(double x, double y, double length, bool);
185 void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
187 void start_note_diff_command (std::string name = "midi edit");
188 void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
189 void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
190 void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
191 void note_diff_remove_note (ArdourCanvas::CanvasNoteEvent* ev);
194 void apply_diff_as_subcommand();
195 void abort_command();
197 void note_entered(ArdourCanvas::CanvasNoteEvent* ev);
198 void note_left(ArdourCanvas::CanvasNoteEvent* ev);
199 void note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
200 void unique_select(ArdourCanvas::CanvasNoteEvent* ev);
201 void note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add, bool extend=false);
202 void note_deselected(ArdourCanvas::CanvasNoteEvent* ev);
203 void delete_selection();
204 void delete_note (boost::shared_ptr<NoteType>);
205 size_t selection_size() { return _selection.size(); }
207 void move_selection(double dx, double dy, double cumulative_dy);
208 void note_dropped (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::frameoffset_t, int8_t d_note);
210 void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
211 void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
213 /** Return true iff the note is within the extent of the region.
214 * @param visible will be set to true if the note is within the visible note range, false otherwise.
216 bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
218 /** Get the region position in pixels relative to session. */
219 double get_position_pixels();
221 /** Get the region end position in pixels relative to session. */
222 double get_end_position_pixels();
224 /** Begin resizing of some notes.
225 * Called by CanvasMidiNote when resizing starts.
226 * @param at_front which end of the note (true == note on, false == note off)
228 void begin_resizing(bool at_front);
230 void update_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
231 void commit_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
233 /** Change the channel of the selection.
234 * @param channel - the channel number of the new channel, zero-based
236 void change_channel(uint8_t channel);
246 MouseState mouse_state() const { return _mouse_state; }
248 struct NoteResizeData {
249 ArdourCanvas::CanvasNote *canvas_note;
250 ArdourCanvas::SimpleRect *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_frame(double x);
265 /** Snap a region relative frame coordinate to frame units.
266 * @param x a pixel coordinate relative to region start
267 * @return the snapped framepos_t coordinate relative to region start
269 framepos_t snap_frame_to_frame(framepos_t x);
271 /** Convert a timestamp in beats to frames (both relative to region start) */
272 framepos_t beats_to_frames(double beats) const;
274 /** Convert a timestamp in frames to beats (both relative to region start) */
275 double frames_to_beats(framepos_t) const;
277 void goto_previous_note ();
278 void goto_next_note ();
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);
281 void transpose (bool up, bool fine, bool allow_smush);
282 void nudge_notes (bool forward);
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 trim_front_starting ();
291 void trim_front_ending ();
294 /** Allows derived types to specify their visibility requirements
295 * to the TimeAxisViewItem parent class.
297 MidiRegionView (ArdourCanvas::Group *,
299 boost::shared_ptr<ARDOUR::MidiRegion>,
300 double samples_per_unit,
301 Gdk::Color& basic_color,
302 TimeAxisViewItem::Visibility);
304 void region_resized (const PBD::PropertyChange&);
306 void set_flags (XMLNode *);
309 void reset_width_dependent_items (double pixel_width);
313 friend class EditNoteDialog;
315 /** Play the NoteOn event of the given note immediately
316 * and schedule the playback of the corresponding NoteOff event.
318 void play_midi_note(boost::shared_ptr<NoteType> note);
319 void play_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
321 /** Play the NoteOff-Event of the given note immediately
322 * (scheduled by @ref play_midi_note()).
324 bool play_midi_note_off(boost::shared_ptr<NoteType> note);
328 bool canvas_event(GdkEvent* ev);
329 bool note_canvas_event(GdkEvent* ev);
331 void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
332 void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
334 void change_note_channel (ArdourCanvas::CanvasNoteEvent *, int8_t);
335 void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
336 void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
337 void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
338 void change_note_length (ArdourCanvas::CanvasNoteEvent *, ARDOUR::MidiModel::TimeType);
339 void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
340 ARDOUR::MidiModel::TimeType end_delta);
342 void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
343 void clear_selection() { clear_selection_except(NULL); }
344 void update_drag_selection(double last_x, double x, double last_y, double y);
346 void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
347 void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
349 int8_t _force_channel;
350 uint16_t _last_channel_selection;
351 uint8_t _current_range_min;
352 uint8_t _current_range_max;
354 /// MIDNAM information of the current track: Model name of MIDNAM file
355 std::string _model_name;
357 /// MIDNAM information of the current track: CustomDeviceMode
358 std::string _custom_device_mode;
360 typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
361 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
362 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
364 boost::shared_ptr<ARDOUR::MidiModel> _model;
366 PgmChanges _pgm_changes;
368 ArdourCanvas::CanvasNote** _active_notes;
369 ArdourCanvas::Group* _note_group;
370 ARDOUR::MidiModel::NoteDiffCommand* _note_diff_command;
371 ArdourCanvas::CanvasNote* _ghost_note;
372 double _last_ghost_x;
373 double _last_ghost_y;
374 double _drag_start_x;
375 double _drag_start_y;
378 ArdourCanvas::SimpleRect* _drag_rect;
379 ArdourCanvas::SimpleRect* _step_edit_cursor;
380 Evoral::MusicalTime _step_edit_cursor_width;
381 Evoral::MusicalTime _step_edit_cursor_position;
383 /** A group used to temporarily reparent _note_group to during start trims, so
384 * that the notes don't move with the parent region view.
386 ArdourCanvas::Group* _temporary_note_group;
388 MouseState _mouse_state;
391 typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
392 /// Currently selected CanvasNoteEvents
393 Selection _selection;
396 void time_sort_events ();
398 MidiCutBuffer* selection_as_cut_buffer () const;
400 /** New notes (created in the current command) which should be selected
401 * when they appear after the command is applied. */
402 std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
404 /** New notes (created in the current command) which should have visible velocity
405 * when they appear after the command is applied. */
406 std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
408 std::vector<NoteResizeData *> _resize_data;
410 /** connection used to connect to model's ContentChanged signal */
411 PBD::ScopedConnection content_connection;
413 ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
414 Events::iterator _optimization_iterator;
416 void update_note (ArdourCanvas::CanvasNote*);
417 double update_hit (ArdourCanvas::CanvasHit *);
418 void create_ghost_note (double, double);
419 void update_ghost_note (double, double);
421 MidiListEditor* _list_editor;
424 PBD::ScopedConnection note_delete_connection;
425 void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
427 void snap_changed ();
428 PBD::ScopedConnection snap_changed_connection;
430 void show_verbose_canvas_cursor (boost::shared_ptr<NoteType>) const;
432 bool motion (GdkEventMotion*);
433 bool scroll (GdkEventScroll*);
434 bool key_press (GdkEventKey*);
435 bool key_release (GdkEventKey*);
436 bool button_press (GdkEventButton*);
437 bool button_release (GdkEventButton*);
438 bool enter_notify (GdkEventCrossing*);
439 bool leave_notify (GdkEventCrossing*);
441 void drop_down_keys ();
442 void maybe_select_by_position (GdkEventButton* ev, double x, double y);
443 void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
445 void display_program_changes_on_channel (uint8_t);
447 void connect_to_diskstream ();
448 void data_recorded (boost::shared_ptr<ARDOUR::MidiBuffer>, boost::weak_ptr<ARDOUR::MidiSource>);
450 void remove_ghost_note ();
451 void mouse_mode_changed ();
452 double _last_event_x;
453 double _last_event_y;
455 PBD::ScopedConnection _mouse_mode_connection;
457 Gdk::Cursor* pre_enter_cursor;
461 #endif /* __gtk_ardour_midi_region_view_h__ */