2 Copyright (C) 2001-2007 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__
24 #include <libgnomecanvasmm.h>
25 #include <libgnomecanvasmm/polygon.h>
26 #include <ardour/midi_track.h>
27 #include <ardour/midi_region.h>
28 #include <ardour/midi_model.h>
29 #include <ardour/diskstream.h>
30 #include <ardour/types.h>
32 #include "region_view.h"
33 #include "midi_time_axis.h"
34 #include "time_axis_view_item.h"
35 #include "automation_line.h"
38 #include "canvas-note.h"
39 #include "canvas-note-event.h"
40 #include "canvas-program-change.h"
49 struct PatchPrimaryKey;
53 class MidiTimeAxisView;
55 class AutomationTimeAxisView;
56 class AutomationRegionView;
58 class MidiRegionView : public RegionView
61 MidiRegionView (ArdourCanvas::Group *,
63 boost::shared_ptr<ARDOUR::MidiRegion>,
64 double initial_samples_per_unit,
65 Gdk::Color& basic_color);
67 MidiRegionView (const MidiRegionView& other);
68 MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
72 virtual void init (Gdk::Color& basic_color, bool wfd);
74 inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
75 { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
77 inline MidiTimeAxisView* midi_view() const
78 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
80 inline MidiStreamView* midi_stream_view() const
81 { return midi_view()->midi_view(); }
83 void set_height (double);
84 void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
86 inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
88 void set_frame_color();
90 void redisplay_model();
92 GhostRegion* add_ghost (TimeAxisView&);
94 void add_note(const boost::shared_ptr<Evoral::Note> note);
95 void resolve_note(uint8_t note_num, double end_time);
103 ControlEvent(nframes_t a_time, uint8_t a_value, uint8_t a_channel)
104 : time(a_time), value(a_value), channel(a_channel) {}
106 ControlEvent& operator=(const ControlEvent& other) {
109 channel = other.channel;
114 /** Add a new program change flag to the canvas.
115 * @param program the MidiRegionView::ControlEvent to add
116 * @param the text to display in the flag
118 void add_pgm_change(ControlEvent& program, string displaytext);
120 /** Look up the given time and channel in the 'automation' and set keys accordingly.
121 * @param time the time of the program change event
122 * @param channel the MIDI channel of the event
123 * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
124 * will be set according to the result of the lookup
126 void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
128 /** Change the 'automation' data of old_program to new values which correspond to new_patch.
129 * @param old_program identifies the program change event which is to be altered
130 * @param new_patch defines the new lsb, msb and program number which are to be set in the automation list data
132 void alter_program_change(ControlEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
134 /** Alter a given program to the new given one.
135 * (Called on context menu select on CanvasProgramChange)
137 void program_selected(
138 ArdourCanvas::CanvasProgramChange& program,
139 const MIDI::Name::PatchPrimaryKey& new_patch);
141 /** Alter a given program to be its predecessor in the MIDNAM file.
143 void previous_program(ArdourCanvas::CanvasProgramChange& program);
145 /** Alters a given program to be its successor in the MIDNAM file.
147 void next_program(ArdourCanvas::CanvasProgramChange& program);
149 /** Displays all program changed events in the region as flags on the canvas.
151 void find_and_insert_program_change_flags();
155 void extend_active_notes();
157 void create_note_at(double x, double y, double duration);
159 void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
161 void start_delta_command(string name = "midi edit");
162 void command_add_note(const boost::shared_ptr<Evoral::Note> note, bool selected);
163 void command_remove_note(ArdourCanvas::CanvasNoteEvent* ev);
165 void apply_command();
166 void abort_command();
168 void note_entered(ArdourCanvas::CanvasNoteEvent* ev);
169 void unique_select(ArdourCanvas::CanvasNoteEvent* ev);
170 void note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add);
171 void note_deselected(ArdourCanvas::CanvasNoteEvent* ev, bool add);
172 void delete_selection();
173 size_t selection_size() { return _selection.size(); }
175 void move_selection(double dx, double dy);
176 void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double dt, uint8_t dnote);
178 /** Get the region position in pixels.
179 * This function is needed to subtract the region start in pixels
180 * from world coordinates submitted by the mouse
182 double get_position_pixels();
184 /** Begin resizing of some notes.
185 * Called by CanvasMidiNote when resizing starts.
186 * @param note_end which end of the note, NOTE_ON or NOTE_OFF
188 void begin_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end);
190 /** Update resizing notes while user drags.
191 * @param note_end which end of the note, NOTE_ON or NOTE_OFF
192 * @param x the difference in mouse motion, ie the motion difference if relative=true
193 * or the absolute mouse position (track-relative) if relative is false
194 * @param relative true if relative resizing is taking place, false if absolute resizing
196 void update_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end, double x, bool relative);
198 /** Finish resizing notes when the user releases the mouse button.
199 * @param note_end which end of the note, NOTE_ON or NOTE_OFF
200 * @param event_x the absolute mouse position (track-relative)
201 * @param relative true if relative resizing is taking place, false if absolute resizing
203 void commit_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end, double event_x, bool relative);
205 /** Adjust the velocity on a note, and the selection if applicable.
206 * @param velocity the relative or absolute velocity
207 * @param relative whether velocity is relative or absolute
209 void change_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
211 /** Change the channel of the selection.
212 * @param channel - the channel number of the new channel, zero-based
214 void change_channel(uint8_t channel);
216 enum MouseState { None, Pressed, SelectTouchDragging, SelectRectDragging, AddDragging, EraseTouchDragging };
217 MouseState mouse_state() const { return _mouse_state; }
219 struct NoteResizeData {
220 ArdourCanvas::CanvasNote *canvas_note;
221 ArdourCanvas::SimpleRect *resize_rect;
225 /** Snap a region relative pixel coordinate to pixel units.
226 * for pixel units (double) instead of nframes64_t
227 * @param x a pixel coordinate relative to region start
228 * @return the snapped pixel coordinate relative to region start
230 double snap_to_pixel(double x);
232 /** Snap a region relative pixel coordinate to frame units.
233 * @param x a pixel coordinate relative to region start
234 * @return the snapped nframes64_t coordinate relative to region start
236 nframes64_t snap_to_frame(double x);
238 /** Snap a region relative frame coordinate to frame units.
239 * @param x a pixel coordinate relative to region start
240 * @return the snapped nframes64_t coordinate relative to region start
242 nframes64_t snap_to_frame(nframes64_t x);
246 /** Allows derived types to specify their visibility requirements
247 * to the TimeAxisViewItem parent class.
249 MidiRegionView (ArdourCanvas::Group *,
251 boost::shared_ptr<ARDOUR::MidiRegion>,
252 double samples_per_unit,
253 Gdk::Color& basic_color,
254 TimeAxisViewItem::Visibility);
256 void region_resized (ARDOUR::Change);
258 void set_flags (XMLNode *);
261 void reset_width_dependent_items (double pixel_width);
266 void switch_source(boost::shared_ptr<ARDOUR::Source> src);
268 bool canvas_event(GdkEvent* ev);
269 bool note_canvas_event(GdkEvent* ev);
271 void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
272 void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
274 void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
276 void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
277 void clear_selection() { clear_selection_except(NULL); }
278 void update_drag_selection(double last_x, double x, double last_y, double y);
280 int8_t _force_channel;
281 uint16_t _last_channel_selection;
282 double _default_note_length;
283 uint8_t _current_range_min;
284 uint8_t _current_range_max;
287 string _custom_device_mode;
289 typedef std::vector<ArdourCanvas::CanvasNoteEvent*> Events;
290 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
292 boost::shared_ptr<ARDOUR::MidiModel> _model;
294 PgmChanges _pgm_changes;
295 ArdourCanvas::CanvasNote** _active_notes;
296 ArdourCanvas::Group* _note_group;
297 ARDOUR::MidiModel::DeltaCommand* _delta_command;
299 MouseState _mouse_state;
302 typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
303 /// Currently selected CanvasNoteEvents
304 Selection _selection;
306 /** New notes (created in the current command) which should be selected
307 * when they appear after the command is applied. */
308 std::set< boost::shared_ptr<Evoral::Note> > _marked_for_selection;
310 std::vector<NoteResizeData *> _resize_data;
313 #endif /* __gtk_ardour_midi_region_view_h__ */