change note colors on the fly, to permit user-definition of colors more easily; remov...
[ardour.git] / gtk2_ardour / midi_region_view.h
1 /*
2     Copyright (C) 2001-2007 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-program-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
68 class MidiRegionView : public RegionView
69 {
70   public:
71         typedef Evoral::Note<Evoral::MusicalTime> NoteType;
72         typedef Evoral::Sequence<Evoral::MusicalTime>::Notes Notes;
73
74         MidiRegionView (ArdourCanvas::Group *,
75                         RouteTimeAxisView&,
76                         boost::shared_ptr<ARDOUR::MidiRegion>,
77                         double initial_samples_per_unit,
78                         Gdk::Color const & basic_color);
79
80         MidiRegionView (const MidiRegionView& other);
81         MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
82
83         ~MidiRegionView ();
84
85         virtual void init (Gdk::Color const & basic_color, bool wfd);
86
87         inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
88                 { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
89
90         inline MidiTimeAxisView* midi_view() const
91                 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
92
93         inline MidiStreamView* midi_stream_view() const
94                 { return midi_view()->midi_view(); }
95
96         void add_note (uint8_t channel, uint8_t number, uint8_t velocity,
97                        Evoral::MusicalTime pos, Evoral::MusicalTime len);
98
99         void set_height (double);
100         void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
101
102         inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
103
104         void set_frame_color();
105         void color_handler ();
106
107         void redisplay_model();
108
109         GhostRegion* add_ghost (TimeAxisView&);
110
111         void add_note(const boost::shared_ptr<NoteType> note, bool visible);
112         void resolve_note(uint8_t note_num, double end_time);
113
114         void cut_copy_clear (Editing::CutCopyOp);
115         void paste (nframes64_t pos, float times, const MidiCutBuffer&);
116
117         struct PCEvent {
118                 PCEvent(double a_time, uint8_t a_value, uint8_t a_channel)
119                         : time(a_time), value(a_value), channel(a_channel) {}
120
121                 double  time;
122                 uint8_t value;
123                 uint8_t channel;
124         };
125
126         /** Add a new program change flag to the canvas.
127          * @param program the MidiRegionView::PCEvent to add
128          * @param the text to display in the flag
129          */
130         void add_pgm_change(PCEvent& program, const std::string& displaytext);
131
132         /** Look up the given time and channel in the 'automation' and set keys accordingly.
133          * @param time the time of the program change event
134          * @param channel the MIDI channel of the event
135          * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
136          *        will be set according to the result of the lookup
137          */
138         void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
139
140         /** Change the 'automation' data of old_program to new values which correspond to new_patch.
141          * @param old_program the program change event which is to be altered
142          * @param new_patch the new lsb, msb and program number which are to be set
143          */
144         void alter_program_change(PCEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
145
146         /** Alter a given program to the new given one.
147          * (Called on context menu select on CanvasProgramChange)
148          */
149         void program_selected(
150                 ArdourCanvas::CanvasProgramChange& program,
151                 const MIDI::Name::PatchPrimaryKey& new_patch);
152
153         /** Alter a given program to be its predecessor in the MIDNAM file.
154          */
155         void previous_program(ArdourCanvas::CanvasProgramChange& program);
156
157         /** Alters a given program to be its successor in the MIDNAM file.
158          */
159         void next_program(ArdourCanvas::CanvasProgramChange& program);
160
161         /** Displays all program change events in the region as flags on the canvas.
162          */
163         void display_program_changes();
164
165         /** Displays all system exclusive events in the region as flags on the canvas.
166          */
167         void display_sysexes();
168
169         void begin_write();
170         void end_write();
171         void extend_active_notes();
172
173         void create_note_at(double x, double y, double length, bool);
174
175         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
176
177         void start_diff_command(std::string name = "midi edit");
178         void diff_add_change(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::DiffCommand::Property, uint8_t val);
179         void diff_add_change(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::DiffCommand::Property, Evoral::MusicalTime val);
180         void diff_add_note(const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity=false);
181         void diff_remove_note(ArdourCanvas::CanvasNoteEvent* ev);
182
183         void apply_diff();
184         void apply_diff_as_subcommand();
185         void abort_command();
186
187         void   note_entered(ArdourCanvas::CanvasNoteEvent* ev);
188         void   note_left(ArdourCanvas::CanvasNoteEvent* ev);
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
196         void move_selection(double dx, double dy);
197         void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double d_pixels, 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::CanvasNote *, bool, double, bool);
220         void commit_resizing (ArdourCanvas::CanvasNote *, bool, double, bool);
221
222         /** Adjust the velocity on a note, and the selection if applicable.
223          * @param velocity the relative or absolute velocity
224          * @param relative whether velocity is relative or absolute
225          */
226         void change_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
227
228         /** Change the channel of the selection.
229          * @param channel - the channel number of the new channel, zero-based
230          */
231         void change_channel(uint8_t channel);
232
233         enum MouseState {
234                 None,
235                 Pressed,
236                 SelectTouchDragging,
237                 SelectRectDragging,
238                 AddDragging
239         };
240
241         MouseState mouse_state() const { return _mouse_state; }
242
243         struct NoteResizeData {
244                 ArdourCanvas::CanvasNote  *canvas_note;
245                 ArdourCanvas::SimpleRect  *resize_rect;
246         };
247
248         /** Snap a region relative pixel coordinate to pixel units.
249          * @param x a pixel coordinate relative to region start
250          * @return the snapped pixel coordinate relative to region start
251          */
252         double snap_to_pixel(double x);
253
254         /** Snap a region relative pixel coordinate to frame units.
255          * @param x a pixel coordinate relative to region start
256          * @return the snapped nframes64_t coordinate relative to region start
257          */
258         nframes64_t snap_pixel_to_frame(double x);
259
260         /** Snap a region relative frame coordinate to frame units.
261          * @param x a pixel coordinate relative to region start
262          * @return the snapped nframes64_t coordinate relative to region start
263          */
264         nframes64_t snap_frame_to_frame(nframes64_t x);
265
266         /** Convert a timestamp in beats to frames (both relative to region start) */
267         nframes64_t beats_to_frames(double beats) const;
268
269         /** Convert a timestamp in frames to beats (both relative to region start) */
270         double frames_to_beats(nframes64_t) const;
271
272         void goto_previous_note ();
273         void goto_next_note ();
274         void change_note_lengths (bool, bool, bool start, bool end);
275         void change_velocities (bool up, bool fine, bool allow_smush);
276         void transpose (bool up, bool fine, bool allow_smush);
277         void nudge_notes (bool forward);
278
279         void show_list_editor ();
280
281         void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
282         
283   protected:
284         /** Allows derived types to specify their visibility requirements
285          * to the TimeAxisViewItem parent class.
286          */
287         MidiRegionView (ArdourCanvas::Group *,
288                         RouteTimeAxisView&,
289                         boost::shared_ptr<ARDOUR::MidiRegion>,
290                         double samples_per_unit,
291                         Gdk::Color& basic_color,
292                         TimeAxisViewItem::Visibility);
293
294         void region_resized (const PBD::PropertyChange&);
295
296         void set_flags (XMLNode *);
297         void store_flags ();
298
299         void reset_width_dependent_items (double pixel_width);
300
301   private:
302         /** Play the NoteOn event of the given note immediately
303          * and schedule the playback of the corresponding NoteOff event.
304          */
305         void play_midi_note(boost::shared_ptr<NoteType> note);
306
307         /** Play the NoteOff-Event of the given note immediately
308          * (scheduled by @ref play_midi_note()).
309          */
310         bool play_midi_note_off(boost::shared_ptr<NoteType> note);
311
312         void clear_events();
313         void switch_source(boost::shared_ptr<ARDOUR::Source> src);
314
315         bool canvas_event(GdkEvent* ev);
316         bool note_canvas_event(GdkEvent* ev);
317
318         void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
319         void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
320
321         void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
322         void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
323         void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
324         void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
325                        ARDOUR::MidiModel::TimeType end_delta);
326
327         void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
328         void clear_selection() { clear_selection_except(NULL); }
329         void update_drag_selection(double last_x, double x, double last_y, double y);
330
331         void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
332         void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
333
334         int8_t   _force_channel;
335         uint16_t _last_channel_selection;
336         uint8_t  _current_range_min;
337         uint8_t  _current_range_max;
338
339         /// MIDNAM information of the current track: Model name of MIDNAM file
340         std::string _model_name;
341
342         /// MIDNAM information of the current track: CustomDeviceMode
343         std::string _custom_device_mode;
344
345         typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
346         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
347         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
348
349         boost::shared_ptr<ARDOUR::MidiModel> _model;
350         Events                               _events;
351         PgmChanges                           _pgm_changes;
352         SysExes                              _sys_exes;
353         ArdourCanvas::CanvasNote**           _active_notes;
354         ArdourCanvas::Group*                 _note_group;
355         ARDOUR::MidiModel::DiffCommand*      _diff_command;
356         ArdourCanvas::CanvasNote*            _ghost_note;
357         double                               _last_ghost_x;
358         double                               _last_ghost_y;
359         double                               _drag_start_x;
360         double                               _drag_start_y;
361         double                               _last_x;
362         double                               _last_y;
363         ArdourCanvas::SimpleRect*            _drag_rect;
364
365         MouseState _mouse_state;
366         int _pressed_button;
367
368         typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
369         /// Currently selected CanvasNoteEvents
370         Selection _selection;
371
372         bool _sort_needed;
373         void time_sort_events ();
374
375         MidiCutBuffer* selection_as_cut_buffer () const;
376
377         /** New notes (created in the current command) which should be selected
378          * when they appear after the command is applied. */
379         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
380
381         /** New notes (created in the current command) which should have visible velocity
382          * when they appear after the command is applied. */
383         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
384
385         std::vector<NoteResizeData *> _resize_data;
386
387         /* connection used to connect to model's ContentChanged signal */
388         PBD::ScopedConnection content_connection;
389
390         ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
391         Events::iterator _optimization_iterator;
392
393         void update_note (ArdourCanvas::CanvasNote*);
394         void update_hit (ArdourCanvas::CanvasHit*);
395         void create_ghost_note (double, double);
396         void update_ghost_note (double, double);
397
398         MidiListEditor* _list_editor;
399         bool no_sound_notes;
400
401         PBD::ScopedConnection note_delete_connection;
402         void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
403
404         void snap_changed ();
405         PBD::ScopedConnection snap_changed_connection;
406
407         void show_verbose_canvas_cursor (boost::shared_ptr<NoteType>) const;
408
409         bool motion (GdkEventMotion*);
410         bool scroll (GdkEventScroll*);
411         bool key_press (GdkEventKey*);
412         bool key_release (GdkEventKey*);
413         bool button_press (GdkEventButton*);
414         bool button_release (GdkEventButton*);
415         bool enter_notify (GdkEventCrossing*);
416         bool leave_notify (GdkEventCrossing*);
417
418         void drop_down_keys ();
419         void maybe_select_by_position (GdkEventButton* ev, double x, double y);
420         void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
421 };
422
423
424 #endif /* __gtk_ardour_midi_region_view_h__ */