Another go at fixing up MIDI note additions with snap
[ardour.git] / gtk2_ardour / midi_region_view.h
1 /*
2     Copyright (C) 2001-2011 Paul Davis
3
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.
8
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.
13
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.
17 */
18
19 #ifndef __gtk_ardour_midi_region_view_h__
20 #define __gtk_ardour_midi_region_view_h__
21
22 #include <string>
23 #include <vector>
24
25 #include <libgnomecanvasmm.h>
26 #include <libgnomecanvasmm/polygon.h>
27
28 #include "pbd/signals.h"
29
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"
35
36 #include "editing.h"
37 #include "region_view.h"
38 #include "midi_time_axis.h"
39 #include "time_axis_view_item.h"
40 #include "automation_line.h"
41 #include "enums.h"
42 #include "canvas.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"
48
49 namespace ARDOUR {
50         class MidiRegion;
51         class MidiModel;
52         class Filter;
53 };
54
55 namespace MIDI {
56         namespace Name {
57                 struct PatchPrimaryKey;
58         };
59 };
60
61 class MidiTimeAxisView;
62 class GhostRegion;
63 class AutomationTimeAxisView;
64 class AutomationRegionView;
65 class MidiCutBuffer;
66 class MidiListEditor;
67 class EditNoteDialog;
68
69 class MidiRegionView : public RegionView
70 {
71 public:
72         typedef Evoral::Note<Evoral::MusicalTime> NoteType;
73         typedef Evoral::Sequence<Evoral::MusicalTime>::Notes Notes;
74
75         MidiRegionView (ArdourCanvas::Group *,
76                         RouteTimeAxisView&,
77                         boost::shared_ptr<ARDOUR::MidiRegion>,
78                         double initial_samples_per_unit,
79                         Gdk::Color const & basic_color);
80
81         MidiRegionView (const MidiRegionView& other);
82         MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
83
84         ~MidiRegionView ();
85
86         virtual void init (Gdk::Color const & basic_color, bool wfd);
87
88         inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
89         { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
90
91         inline MidiTimeAxisView* midi_view() const
92         { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
93
94         inline MidiStreamView* midi_stream_view() const
95         { return midi_view()->midi_view(); }
96
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);
102
103         inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
104
105         void set_frame_color();
106         void color_handler ();
107
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);
112
113         void redisplay_model();
114
115         GhostRegion* add_ghost (TimeAxisView&);
116
117         void add_note(const boost::shared_ptr<NoteType> note, bool visible);
118         void resolve_note(uint8_t note_num, double end_time);
119
120         void cut_copy_clear (Editing::CutCopyOp);
121         void paste (framepos_t pos, float times, const MidiCutBuffer&);
122
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
126          */
127         void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext);
128
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
134          */
135         void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
136
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
140          */
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 &);
143
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 *);
148
149         /** Alter a given patch to be its predecessor in the MIDNAM file.
150          */
151         void previous_patch (ArdourCanvas::CanvasPatchChange &);
152
153         /** Alters a given patch to be its successor in the MIDNAM file.
154          */
155         void next_patch (ArdourCanvas::CanvasPatchChange &);
156
157         void previous_bank (ArdourCanvas::CanvasPatchChange &);
158         void next_bank (ArdourCanvas::CanvasPatchChange &);
159
160         /** Displays all patch change events in the region as flags on the canvas.
161          */
162         void display_patch_changes();
163
164         /** Displays all system exclusive events in the region as flags on the canvas.
165          */
166         void display_sysexes();
167
168         void begin_write();
169         void end_write();
170         void extend_active_notes();
171
172         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
173
174         void start_note_diff_command (std::string name = "midi edit");
175         void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
176         void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
177         void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
178         void note_diff_remove_note (ArdourCanvas::CanvasNoteEvent* ev);
179
180         void apply_diff (bool as_subcommand = false);
181         void abort_command();
182
183         void   note_entered(ArdourCanvas::CanvasNoteEvent* ev);
184         void   note_left(ArdourCanvas::CanvasNoteEvent* ev);
185         void   patch_entered (ArdourCanvas::CanvasPatchChange *);
186         void   patch_left (ArdourCanvas::CanvasPatchChange *);
187         void   note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
188         void   unique_select(ArdourCanvas::CanvasNoteEvent* ev);
189         void   note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add, bool extend=false);
190         void   note_deselected(ArdourCanvas::CanvasNoteEvent* ev);
191         void   delete_selection();
192         void   delete_note (boost::shared_ptr<NoteType>);
193         size_t selection_size() { return _selection.size(); }
194         void   select_all_notes ();
195
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);
198
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);
201
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.
204          */
205         bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
206
207         /** Get the region position in pixels relative to session. */
208         double get_position_pixels();
209
210         /** Get the region end position in pixels relative to session. */
211         double get_end_position_pixels();
212
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)
216          */
217         void begin_resizing(bool at_front);
218
219         void update_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
220         void commit_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
221
222         /** Change the channel of the selection.
223          * @param channel - the channel number of the new channel, zero-based
224          */
225         void change_channel(uint8_t channel);
226
227         enum MouseState {
228                 None,
229                 Pressed,
230                 SelectTouchDragging,
231                 SelectRectDragging,
232                 AddDragging
233         };
234
235         MouseState mouse_state() const { return _mouse_state; }
236
237         struct NoteResizeData {
238                 ArdourCanvas::CanvasNote  *canvas_note;
239                 ArdourCanvas::SimpleRect  *resize_rect;
240         };
241
242         /** Snap a region relative pixel coordinate to pixel units.
243          * @param x a pixel coordinate relative to region start
244          * @return the snapped pixel coordinate relative to region start
245          */
246         double snap_to_pixel(double x);
247
248         /** Snap a region relative pixel coordinate to frame units.
249          * @param x a pixel coordinate relative to region start
250          * @return the snapped framepos_t coordinate relative to region start
251          */
252         framepos_t snap_pixel_to_frame(double x);
253
254         ARDOUR::frameoffset_t snap_frame_to_frame (ARDOUR::frameoffset_t) const;
255
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);
261         }
262         /** Convert a timestamp in frames to beats (both relative to region start) */
263         double region_frames_to_region_beats(framepos_t) const;
264
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();
270         }
271         /** Convert a timestamp in absolute frames to beats measured from source start*/
272         double absolute_frames_to_source_beats(framepos_t) const;
273
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 ();
281
282         void show_list_editor ();
283
284         void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
285
286         void enable_display (bool);
287
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; }
290
291         void trim_front_starting ();
292         void trim_front_ending ();
293
294 protected:
295         /** Allows derived types to specify their visibility requirements
296          * to the TimeAxisViewItem parent class.
297          */
298         MidiRegionView (ArdourCanvas::Group *,
299                         RouteTimeAxisView&,
300                         boost::shared_ptr<ARDOUR::MidiRegion>,
301                         double samples_per_unit,
302                         Gdk::Color& basic_color,
303                         TimeAxisViewItem::Visibility);
304
305         void region_resized (const PBD::PropertyChange&);
306
307         void set_flags (XMLNode *);
308         void store_flags ();
309
310         void reset_width_dependent_items (double pixel_width);
311
312         void parameter_changed (std::string const & p);
313
314 private:
315
316         friend class EditNoteDialog;
317
318         void create_note_at(double x, double y, double length, bool, bool);
319
320         /** Play the NoteOn event of the given note immediately
321          * and schedule the playback of the corresponding NoteOff event.
322          */
323         void play_midi_note(boost::shared_ptr<NoteType> note);
324         void play_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
325
326         /** Play the NoteOff-Event of the given note immediately
327          * (scheduled by @ref play_midi_note()).
328          */
329         bool play_midi_note_off(boost::shared_ptr<NoteType> note);
330
331         void clear_events();
332
333         bool canvas_event(GdkEvent* ev);
334         bool note_canvas_event(GdkEvent* ev);
335
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);
338
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);
346
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);
350
351         void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
352         void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
353
354         void show_verbose_cursor (std::string const &, double, double) const;
355         void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
356
357         int8_t   _force_channel;
358         uint16_t _last_channel_selection;
359         uint8_t  _current_range_min;
360         uint8_t  _current_range_max;
361
362         /// MIDNAM information of the current track: Model name of MIDNAM file
363         std::string _model_name;
364
365         /// MIDNAM information of the current track: CustomDeviceMode
366         std::string _custom_device_mode;
367
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;
371
372         boost::shared_ptr<ARDOUR::MidiModel> _model;
373         Events                               _events;
374         PatchChanges                         _patch_changes;
375         SysExes                              _sys_exes;
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;
384         double                               _last_x;
385         double                               _last_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;
391
392
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.
395          */
396         ArdourCanvas::Group*                 _temporary_note_group;
397
398         MouseState _mouse_state;
399         int _pressed_button;
400
401         typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
402         /// Currently selected CanvasNoteEvents
403         Selection _selection;
404
405         bool _sort_needed;
406         void time_sort_events ();
407
408         MidiCutBuffer* selection_as_cut_buffer () const;
409
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;
413
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;
417
418         std::vector<NoteResizeData *> _resize_data;
419
420         /** connection used to connect to model's ContentChanged signal */
421         PBD::ScopedConnection content_connection;
422
423         ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
424         Events::iterator _optimization_iterator;
425
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);
430
431         MidiListEditor* _list_editor;
432         bool _no_sound_notes;
433
434         PBD::ScopedConnection note_delete_connection;
435         void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
436
437         void snap_changed ();
438         PBD::ScopedConnection snap_changed_connection;
439
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*);
448
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);
452
453         void display_patch_changes_on_channel (uint8_t);
454
455         void connect_to_diskstream ();
456         void data_recorded (boost::shared_ptr<ARDOUR::MidiBuffer>, boost::weak_ptr<ARDOUR::MidiSource>);
457
458         void remove_ghost_note ();
459         void mouse_mode_changed ();
460         double _last_event_x;
461         double _last_event_y;
462
463         framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
464         
465         PBD::ScopedConnection _mouse_mode_connection;
466
467         Gdk::Cursor* _pre_enter_cursor;
468 };
469
470
471 #endif /* __gtk_ardour_midi_region_view_h__ */