6d05e2b8bfcc6f0423d7d3ba396ad055fd380168
[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 #include "ardour/midi_track.h"
28 #include "ardour/midi_region.h"
29 #include "ardour/midi_model.h"
30 #include "ardour/diskstream.h"
31 #include "ardour/types.h"
32
33 #include "editing.h"
34 #include "region_view.h"
35 #include "midi_time_axis.h"
36 #include "time_axis_view_item.h"
37 #include "automation_line.h"
38 #include "enums.h"
39 #include "canvas.h"
40 #include "canvas-hit.h"
41 #include "canvas-note.h"
42 #include "canvas-note-event.h"
43 #include "canvas-program-change.h"
44 #include "canvas-sysex.h"
45
46 namespace ARDOUR {
47         class MidiRegion;
48         class MidiModel;
49         class Filter;
50 };
51
52 namespace MIDI {
53         namespace Name {
54                 struct PatchPrimaryKey;
55         };
56 };
57
58 class MidiTimeAxisView;
59 class GhostRegion;
60 class AutomationTimeAxisView;
61 class AutomationRegionView;
62 class MidiCutBuffer;
63
64 class MidiRegionView : public RegionView
65 {
66   public:
67         typedef Evoral::Note<Evoral::MusicalTime> NoteType;
68         typedef Evoral::Sequence<Evoral::MusicalTime>::Notes NoteList;
69
70         MidiRegionView (ArdourCanvas::Group *,
71                         RouteTimeAxisView&,
72                         boost::shared_ptr<ARDOUR::MidiRegion>,
73                         double initial_samples_per_unit,
74                         Gdk::Color const & basic_color);
75         
76         MidiRegionView (const MidiRegionView& other);
77         MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
78
79         ~MidiRegionView ();
80
81         virtual void init (Gdk::Color const & basic_color, bool wfd);
82
83         inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
84                 { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
85
86         inline MidiTimeAxisView* midi_view() const
87                 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
88
89         inline MidiStreamView* midi_stream_view() const
90                 { return midi_view()->midi_view(); }
91
92         void add_note (uint8_t channel, uint8_t number, uint8_t velocity, 
93                        Evoral::MusicalTime pos, Evoral::MusicalTime len);
94
95         void set_height (double);
96         void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
97
98         inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
99         
100         void set_frame_color();
101
102         void redisplay_model();
103
104         GhostRegion* add_ghost (TimeAxisView&);
105
106         void add_note(const boost::shared_ptr<NoteType> note);
107         void resolve_note(uint8_t note_num, double end_time);
108
109         void cut_copy_clear (Editing::CutCopyOp);
110         void paste (nframes64_t pos, float times, const MidiCutBuffer&);
111
112         struct PCEvent {
113                 PCEvent(double a_time, uint8_t a_value, uint8_t a_channel) 
114                         : time(a_time), value(a_value), channel(a_channel) {}
115
116                 double  time;
117                 uint8_t value;
118                 uint8_t channel;
119         };
120         
121         /** Add a new program change flag to the canvas.
122          * @param program the MidiRegionView::PCEvent to add
123          * @param the text to display in the flag
124          */
125         void add_pgm_change(PCEvent& program, const std::string& displaytext);
126         
127         /** Look up the given time and channel in the 'automation' and set keys accordingly.
128          * @param time the time of the program change event
129          * @param channel the MIDI channel of the event
130          * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will 
131          *        will be set according to the result of the lookup
132          */
133         void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
134         
135         /** Change the 'automation' data of old_program to new values which correspond to new_patch.
136          * @param old_program the program change event which is to be altered
137          * @param new_patch the new lsb, msb and program number which are to be set
138          */
139         void alter_program_change(PCEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
140         
141         /** Alter a given program to the new given one.
142          * (Called on context menu select on CanvasProgramChange)
143          */
144         void program_selected(
145                 ArdourCanvas::CanvasProgramChange& program, 
146                 const MIDI::Name::PatchPrimaryKey& new_patch);
147         
148         /** Alter a given program to be its predecessor in the MIDNAM file.
149          */
150         void previous_program(ArdourCanvas::CanvasProgramChange& program);
151
152         /** Alters a given program to be its successor in the MIDNAM file.
153          */
154         void next_program(ArdourCanvas::CanvasProgramChange& program);
155         
156         /** Displays all program change events in the region as flags on the canvas.
157          */
158         void display_program_changes();
159         
160         /** Displays all system exclusive events in the region as flags on the canvas.
161          */
162         void display_sysexes();
163
164         void begin_write();
165         void end_write();
166         void extend_active_notes();
167
168         void create_note_at(double x, double y, double length);
169
170         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
171
172         void start_delta_command(std::string name = "midi edit");
173         void delta_add_note(const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity=false);
174         void delta_remove_note(ArdourCanvas::CanvasNoteEvent* ev);
175
176         void start_diff_command(std::string name = "midi edit");
177         void diff_add_change(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::DiffCommand::Property, uint8_t val);
178         void diff_add_change(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::DiffCommand::Property, Evoral::MusicalTime val);
179
180         void apply_delta();
181         void apply_diff();
182         void apply_delta_as_subcommand();
183         void apply_diff_as_subcommand();
184         void abort_command();
185
186         void   note_entered(ArdourCanvas::CanvasNoteEvent* ev);
187         void   note_left(ArdourCanvas::CanvasNoteEvent* ev);
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         size_t selection_size() { return _selection.size(); }
193         
194         void move_selection(double dx, double dy);
195         void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double d_pixels, uint8_t d_note);
196
197         /** Return true iff the note is within the currently visible range */
198         bool note_in_visible_range(const boost::shared_ptr<NoteType> note) const;
199
200         /** Get the region position in pixels relative to session. */
201         double get_position_pixels();
202
203         /** Get the region end position in pixels relative to session. */
204         double get_end_position_pixels();
205
206         /** Begin resizing of some notes.
207          * Called by CanvasMidiNote when resizing starts.
208          * @param at_front which end of the note (true == note on, false == note off)
209          */
210         void begin_resizing(bool at_front);
211
212         /** Update resizing notes while user drags.
213          * @param at_front which end of the note (true == note on, false == note off)
214          * @param x the difference in mouse motion, ie the motion difference if relative=true
215          *           or the absolute mouse position (track-relative) if relative is false
216          * @param relative true if relative resizing is taking place, false if absolute resizing
217          */
218         void update_resizing(bool at_front, double x, bool relative);
219
220         /** Finish resizing notes when the user releases the mouse button.
221          * @param at_front which end of the note (true == note on, false == note off)
222          * @param event_x the absolute mouse position (track-relative)
223          * @param relative true if relative resizing is taking place, false if absolute resizing
224          */
225         void commit_resizing(bool at_front, double event_x, bool relative);
226
227         /** Adjust the velocity on a note, and the selection if applicable.
228          * @param velocity the relative or absolute velocity
229          * @param relative whether velocity is relative or absolute
230          */
231         void change_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
232         
233         /** Change the channel of the selection.
234          * @param channel - the channel number of the new channel, zero-based
235          */
236         void change_channel(uint8_t channel);
237
238         enum MouseState {
239                 None,
240                 Pressed,
241                 SelectTouchDragging,
242                 SelectRectDragging,
243                 AddDragging
244         };
245
246         MouseState mouse_state() const { return _mouse_state; }
247
248         struct NoteResizeData {
249                 ArdourCanvas::CanvasNote  *canvas_note;
250                 ArdourCanvas::SimpleRect  *resize_rect;
251         };
252         
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
256          */
257         double snap_to_pixel(double x);
258
259         /** Snap a region relative pixel coordinate to frame units.
260          * @param x a pixel coordinate relative to region start
261          * @return the snapped nframes64_t coordinate relative to region start
262          */
263         nframes64_t snap_pixel_to_frame(double x);
264
265         /** Snap a region relative frame coordinate to frame units.
266          * @param x a pixel coordinate relative to region start
267          * @return the snapped nframes64_t coordinate relative to region start
268          */
269         nframes64_t snap_frame_to_frame(nframes64_t x);
270         
271         /** Convert a timestamp in beats to frames (both relative to region start) */
272         nframes64_t beats_to_frames(double beats) const;
273         
274         /** Convert a timestamp in frames to beats (both relative to region start) */
275         double frames_to_beats(nframes64_t beats) const;
276
277         void goto_previous_note ();
278         void goto_next_note ();
279         void change_note_lengths (bool, bool, 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);
283
284         void show_list_editor ();
285
286         void selection_as_notelist (NoteList& selected);
287
288   protected:
289         /** Allows derived types to specify their visibility requirements
290          * to the TimeAxisViewItem parent class.
291          */
292         MidiRegionView (ArdourCanvas::Group *,
293                         RouteTimeAxisView&,
294                         boost::shared_ptr<ARDOUR::MidiRegion>,
295                         double samples_per_unit,
296                         Gdk::Color& basic_color,
297                         TimeAxisViewItem::Visibility);
298         
299         void region_resized (ARDOUR::Change);
300         
301         void set_flags (XMLNode *);
302         void store_flags ();
303         
304         void reset_width_dependent_items (double pixel_width);
305
306   private:
307         /** Play the NoteOn event of the given note immediately
308          * and schedule the playback of the corresponding NoteOff event.
309          */
310         void play_midi_note(boost::shared_ptr<NoteType> note);
311         
312         /** Play the NoteOff-Event of the given note immediately
313          * (scheduled by @ref play_midi_note()).
314          */
315         bool play_midi_note_off(boost::shared_ptr<NoteType> note);
316
317         void clear_events();
318         void switch_source(boost::shared_ptr<ARDOUR::Source> src);
319
320         bool canvas_event(GdkEvent* ev);
321         bool note_canvas_event(GdkEvent* ev);
322         
323         void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
324         void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
325         
326         void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
327         void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
328         void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
329         void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
330                        ARDOUR::MidiModel::TimeType end_delta);
331
332         void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
333         void clear_selection() { clear_selection_except(NULL); }
334         void update_drag_selection(double last_x, double x, double last_y, double y);
335
336         void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
337         void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
338
339         int8_t   _force_channel;
340         uint16_t _last_channel_selection;
341         double   _default_note_length;
342         uint8_t  _current_range_min;
343         uint8_t  _current_range_max;
344         
345         /// MIDNAM information of the current track: Model name of MIDNAM file
346         std::string _model_name;
347         
348         /// MIDNAM information of the current track: CustomDeviceMode
349         std::string _custom_device_mode;   
350
351         typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
352         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
353         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
354         
355         boost::shared_ptr<ARDOUR::MidiModel> _model;
356         Events                               _events;
357         PgmChanges                           _pgm_changes;
358         SysExes                              _sys_exes;
359         ArdourCanvas::CanvasNote**           _active_notes;
360         ArdourCanvas::Group*                 _note_group;
361         ARDOUR::MidiModel::DeltaCommand*     _delta_command;
362         ARDOUR::MidiModel::DiffCommand*      _diff_command;
363
364         MouseState _mouse_state;
365         int _pressed_button;
366
367         typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
368         /// Currently selected CanvasNoteEvents
369         Selection _selection;
370
371         bool _sort_needed;
372         void time_sort_events ();
373
374         MidiCutBuffer* selection_as_cut_buffer () const;
375
376         /** New notes (created in the current command) which should be selected
377          * when they appear after the command is applied. */
378         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
379         
380         /** New notes (created in the current command) which should have visible velocity
381          * when they appear after the command is applied. */
382         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
383
384         std::vector<NoteResizeData *> _resize_data;
385
386         /* connection used to connect to model's ContentChanged signal */
387         sigc::connection content_connection;
388
389         ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
390         Events::iterator _optimization_iterator;
391
392         void update_note (ArdourCanvas::CanvasNote*);
393         void update_hit (ArdourCanvas::CanvasHit*);
394         
395 };      
396
397
398 #endif /* __gtk_ardour_midi_region_view_h__ */