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 typedef Evoral::Note<ARDOUR::MidiModel::TimeType> NoteType;
63 MidiRegionView (ArdourCanvas::Group *,
65 boost::shared_ptr<ARDOUR::MidiRegion>,
66 double initial_samples_per_unit,
67 Gdk::Color& basic_color);
69 MidiRegionView (const MidiRegionView& other);
70 MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
74 virtual void init (Gdk::Color& basic_color, bool wfd);
76 inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
77 { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
79 inline MidiTimeAxisView* midi_view() const
80 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
82 inline MidiStreamView* midi_stream_view() const
83 { return midi_view()->midi_view(); }
85 void set_height (double);
86 void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
88 inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
90 void set_frame_color();
92 void redisplay_model();
94 GhostRegion* add_ghost (TimeAxisView&);
96 void add_note(const boost::shared_ptr<NoteType> note);
97 void resolve_note(uint8_t note_num, double end_time);
105 ControlEvent(nframes_t a_time, uint8_t a_value, uint8_t a_channel)
106 : time(a_time), value(a_value), channel(a_channel) {}
108 ControlEvent& operator=(const ControlEvent& other) {
111 channel = other.channel;
116 /** Add a new program change flag to the canvas.
117 * @param program the MidiRegionView::ControlEvent to add
118 * @param the text to display in the flag
120 void add_pgm_change(ControlEvent& program, string displaytext);
122 /** Look up the given time and channel in the 'automation' and set keys accordingly.
123 * @param time the time of the program change event
124 * @param channel the MIDI channel of the event
125 * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
126 * will be set according to the result of the lookup
128 void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
130 /** Change the 'automation' data of old_program to new values which correspond to new_patch.
131 * @param old_program identifies the program change event which is to be altered
132 * @param new_patch defines the new lsb, msb and program number which are to be set in the automation list data
134 void alter_program_change(ControlEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
136 /** Alter a given program to the new given one.
137 * (Called on context menu select on CanvasProgramChange)
139 void program_selected(
140 ArdourCanvas::CanvasProgramChange& program,
141 const MIDI::Name::PatchPrimaryKey& new_patch);
143 /** Alter a given program to be its predecessor in the MIDNAM file.
145 void previous_program(ArdourCanvas::CanvasProgramChange& program);
147 /** Alters a given program to be its successor in the MIDNAM file.
149 void next_program(ArdourCanvas::CanvasProgramChange& program);
151 /** Displays all program changed events in the region as flags on the canvas.
153 void display_program_change_flags();
157 void extend_active_notes();
159 void create_note_at(double x, double y, double length);
161 void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
163 void start_delta_command(string name = "midi edit");
164 void command_add_note(const boost::shared_ptr<NoteType> note, bool selected);
165 void command_remove_note(ArdourCanvas::CanvasNoteEvent* ev);
167 void apply_command();
168 void abort_command();
170 void note_entered(ArdourCanvas::CanvasNoteEvent* ev);
171 void unique_select(ArdourCanvas::CanvasNoteEvent* ev);
172 void note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add);
173 void note_deselected(ArdourCanvas::CanvasNoteEvent* ev, bool add);
174 void delete_selection();
175 size_t selection_size() { return _selection.size(); }
177 void move_selection(double dx, double dy);
178 void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double d_frames, uint8_t d_note);
180 /** Return true iff the note is within the currently visible range */
181 bool note_in_visible_range(const boost::shared_ptr<NoteType> note) const;
183 /** Get the region position in pixels relative to session. */
184 double get_position_pixels();
186 /** Begin resizing of some notes.
187 * Called by CanvasMidiNote when resizing starts.
188 * @param note_end which end of the note, NOTE_ON or NOTE_OFF
190 void begin_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end);
192 /** Update resizing notes while user drags.
193 * @param note_end which end of the note, NOTE_ON or NOTE_OFF
194 * @param x the difference in mouse motion, ie the motion difference if relative=true
195 * or the absolute mouse position (track-relative) if relative is false
196 * @param relative true if relative resizing is taking place, false if absolute resizing
198 void update_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end, double x, bool relative);
200 /** Finish resizing notes when the user releases the mouse button.
201 * @param note_end which end of the note, NOTE_ON or NOTE_OFF
202 * @param event_x the absolute mouse position (track-relative)
203 * @param relative true if relative resizing is taking place, false if absolute resizing
205 void commit_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end, double event_x, bool relative);
207 /** Adjust the velocity on a note, and the selection if applicable.
208 * @param velocity the relative or absolute velocity
209 * @param relative whether velocity is relative or absolute
211 void change_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
213 /** Change the channel of the selection.
214 * @param channel - the channel number of the new channel, zero-based
216 void change_channel(uint8_t channel);
227 MouseState mouse_state() const { return _mouse_state; }
229 struct NoteResizeData {
230 ArdourCanvas::CanvasNote *canvas_note;
231 ArdourCanvas::SimpleRect *resize_rect;
235 /** Snap a region relative pixel coordinate to pixel units.
236 * for pixel units (double) instead of nframes64_t
237 * @param x a pixel coordinate relative to region start
238 * @return the snapped pixel coordinate relative to region start
240 double snap_to_pixel(double x);
242 /** Snap a region relative pixel coordinate to frame units.
243 * @param x a pixel coordinate relative to region start
244 * @return the snapped nframes64_t coordinate relative to region start
246 nframes64_t snap_to_frame(double x);
248 /** Snap a region relative frame coordinate to frame units.
249 * @param x a pixel coordinate relative to region start
250 * @return the snapped nframes64_t coordinate relative to region start
252 nframes64_t snap_to_frame(nframes64_t x);
254 /** Convert a timestamp in beats to frames (both relative to region start) */
255 nframes64_t beats_to_frames(double beats) const;
257 /** Convert a timestamp in frames to beats (both relative to region start) */
258 double frames_to_beats(nframes64_t beats) const;
261 /** Allows derived types to specify their visibility requirements
262 * to the TimeAxisViewItem parent class.
264 MidiRegionView (ArdourCanvas::Group *,
266 boost::shared_ptr<ARDOUR::MidiRegion>,
267 double samples_per_unit,
268 Gdk::Color& basic_color,
269 TimeAxisViewItem::Visibility);
271 void region_resized (ARDOUR::Change);
273 void set_flags (XMLNode *);
276 void reset_width_dependent_items (double pixel_width);
279 /** Play the NoteOn event of the given note immediately
280 * and schedule the playback of the corresponding NoteOff event.
282 void play_midi_note(boost::shared_ptr<NoteType> note);
284 /** Play the NoteOff-Event of the given note immediately
285 * (scheduled by @ref play_midi_note()).
287 bool play_midi_note_off(boost::shared_ptr<NoteType> note);
290 void switch_source(boost::shared_ptr<ARDOUR::Source> src);
292 bool canvas_event(GdkEvent* ev);
293 bool note_canvas_event(GdkEvent* ev);
295 void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
296 void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
298 void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
300 void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
301 void clear_selection() { clear_selection_except(NULL); }
302 void update_drag_selection(double last_x, double x, double last_y, double y);
304 int8_t _force_channel;
305 uint16_t _last_channel_selection;
306 double _default_note_length;
307 uint8_t _current_range_min;
308 uint8_t _current_range_max;
310 /// MIDNAM information of the current track: Model name of MIDNAM file
313 /// MIDNAM information of the current track: CustomDeviceMode
314 string _custom_device_mode;
316 typedef std::vector<ArdourCanvas::CanvasNoteEvent*> Events;
317 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
319 boost::shared_ptr<ARDOUR::MidiModel> _model;
321 PgmChanges _pgm_changes;
322 ArdourCanvas::CanvasNote** _active_notes;
323 ArdourCanvas::Group* _note_group;
324 ARDOUR::MidiModel::DeltaCommand* _delta_command;
326 MouseState _mouse_state;
329 typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
330 /// Currently selected CanvasNoteEvents
331 Selection _selection;
333 /** New notes (created in the current command) which should be selected
334 * when they appear after the command is applied. */
335 std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
337 std::vector<NoteResizeData *> _resize_data;
340 #endif /* __gtk_ardour_midi_region_view_h__ */