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__
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"
34 #include "region_view.h"
35 #include "midi_time_axis.h"
36 #include "time_axis_view_item.h"
37 #include "automation_line.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"
54 struct PatchPrimaryKey;
58 class MidiTimeAxisView;
60 class AutomationTimeAxisView;
61 class AutomationRegionView;
64 class MidiRegionView : public RegionView
67 typedef Evoral::Note<Evoral::MusicalTime> NoteType;
68 typedef Evoral::Sequence<Evoral::MusicalTime>::Notes NoteList;
70 MidiRegionView (ArdourCanvas::Group *,
72 boost::shared_ptr<ARDOUR::MidiRegion>,
73 double initial_samples_per_unit,
74 Gdk::Color const & basic_color);
76 MidiRegionView (const MidiRegionView& other);
77 MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
81 virtual void init (Gdk::Color const & basic_color, bool wfd);
83 inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
84 { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
86 inline MidiTimeAxisView* midi_view() const
87 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
89 inline MidiStreamView* midi_stream_view() const
90 { return midi_view()->midi_view(); }
92 void add_note (uint8_t channel, uint8_t number, uint8_t velocity,
93 Evoral::MusicalTime pos, Evoral::MusicalTime len);
95 void set_height (double);
96 void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
98 inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
100 void set_frame_color();
102 void redisplay_model();
104 GhostRegion* add_ghost (TimeAxisView&);
106 void add_note(const boost::shared_ptr<NoteType> note, bool visible);
107 void resolve_note(uint8_t note_num, double end_time);
109 void cut_copy_clear (Editing::CutCopyOp);
110 void paste (nframes64_t pos, float times, const MidiCutBuffer&);
113 PCEvent(double a_time, uint8_t a_value, uint8_t a_channel)
114 : time(a_time), value(a_value), channel(a_channel) {}
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
125 void add_pgm_change(PCEvent& program, const std::string& displaytext);
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
133 void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
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
139 void alter_program_change(PCEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
141 /** Alter a given program to the new given one.
142 * (Called on context menu select on CanvasProgramChange)
144 void program_selected(
145 ArdourCanvas::CanvasProgramChange& program,
146 const MIDI::Name::PatchPrimaryKey& new_patch);
148 /** Alter a given program to be its predecessor in the MIDNAM file.
150 void previous_program(ArdourCanvas::CanvasProgramChange& program);
152 /** Alters a given program to be its successor in the MIDNAM file.
154 void next_program(ArdourCanvas::CanvasProgramChange& program);
156 /** Displays all program change events in the region as flags on the canvas.
158 void display_program_changes();
160 /** Displays all system exclusive events in the region as flags on the canvas.
162 void display_sysexes();
166 void extend_active_notes();
168 void create_note_at(double x, double y, double length);
170 void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
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);
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);
182 void apply_delta_as_subcommand();
183 void apply_diff_as_subcommand();
184 void abort_command();
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(); }
194 void move_selection(double dx, double dy);
195 void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double d_pixels, int8_t d_note);
197 /** Return true iff the note is within the extent of the region.
198 * @param visible will be set to true if the note is within the visible note range, false otherwise.
200 bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
202 /** Get the region position in pixels relative to session. */
203 double get_position_pixels();
205 /** Get the region end position in pixels relative to session. */
206 double get_end_position_pixels();
208 /** Begin resizing of some notes.
209 * Called by CanvasMidiNote when resizing starts.
210 * @param at_front which end of the note (true == note on, false == note off)
212 void begin_resizing(bool at_front);
214 /** Update resizing notes while user drags.
215 * @param at_front which end of the note (true == note on, false == note off)
216 * @param x the difference in mouse motion, ie the motion difference if relative=true
217 * or the absolute mouse position (track-relative) if relative is false
218 * @param relative true if relative resizing is taking place, false if absolute resizing
220 void update_resizing(bool at_front, double x, bool relative);
222 /** Finish resizing notes when the user releases the mouse button.
223 * @param at_front which end of the note (true == note on, false == note off)
224 * @param event_x the absolute mouse position (track-relative)
225 * @param relative true if relative resizing is taking place, false if absolute resizing
227 void commit_resizing(bool at_front, double event_x, bool relative);
229 /** Adjust the velocity on a note, and the selection if applicable.
230 * @param velocity the relative or absolute velocity
231 * @param relative whether velocity is relative or absolute
233 void change_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
235 /** Change the channel of the selection.
236 * @param channel - the channel number of the new channel, zero-based
238 void change_channel(uint8_t channel);
248 MouseState mouse_state() const { return _mouse_state; }
250 struct NoteResizeData {
251 ArdourCanvas::CanvasNote *canvas_note;
252 ArdourCanvas::SimpleRect *resize_rect;
255 /** Snap a region relative pixel coordinate to pixel units.
256 * @param x a pixel coordinate relative to region start
257 * @return the snapped pixel coordinate relative to region start
259 double snap_to_pixel(double x);
261 /** Snap a region relative pixel coordinate to frame units.
262 * @param x a pixel coordinate relative to region start
263 * @return the snapped nframes64_t coordinate relative to region start
265 nframes64_t snap_pixel_to_frame(double x);
267 /** Snap a region relative frame coordinate to frame units.
268 * @param x a pixel coordinate relative to region start
269 * @return the snapped nframes64_t coordinate relative to region start
271 nframes64_t snap_frame_to_frame(nframes64_t x);
273 /** Convert a timestamp in beats to frames (both relative to region start) */
274 nframes64_t beats_to_frames(double beats) const;
276 /** Convert a timestamp in frames to beats (both relative to region start) */
277 double frames_to_beats(nframes64_t beats) const;
279 void goto_previous_note ();
280 void goto_next_note ();
281 void change_note_lengths (bool, bool, bool start, bool end);
282 void change_velocities (bool up, bool fine, bool allow_smush);
283 void transpose (bool up, bool fine, bool allow_smush);
284 void nudge_notes (bool forward);
286 void show_list_editor ();
288 void selection_as_notelist (NoteList& selected);
291 /** Allows derived types to specify their visibility requirements
292 * to the TimeAxisViewItem parent class.
294 MidiRegionView (ArdourCanvas::Group *,
296 boost::shared_ptr<ARDOUR::MidiRegion>,
297 double samples_per_unit,
298 Gdk::Color& basic_color,
299 TimeAxisViewItem::Visibility);
301 void region_resized (ARDOUR::Change);
303 void set_flags (XMLNode *);
306 void reset_width_dependent_items (double pixel_width);
309 /** Play the NoteOn event of the given note immediately
310 * and schedule the playback of the corresponding NoteOff event.
312 void play_midi_note(boost::shared_ptr<NoteType> note);
314 /** Play the NoteOff-Event of the given note immediately
315 * (scheduled by @ref play_midi_note()).
317 bool play_midi_note_off(boost::shared_ptr<NoteType> note);
320 void switch_source(boost::shared_ptr<ARDOUR::Source> src);
322 bool canvas_event(GdkEvent* ev);
323 bool note_canvas_event(GdkEvent* ev);
325 void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
326 void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
328 void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
329 void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
330 void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
331 void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
332 ARDOUR::MidiModel::TimeType end_delta);
334 void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
335 void clear_selection() { clear_selection_except(NULL); }
336 void update_drag_selection(double last_x, double x, double last_y, double y);
338 void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
339 void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
341 int8_t _force_channel;
342 uint16_t _last_channel_selection;
343 double _default_note_length;
344 uint8_t _current_range_min;
345 uint8_t _current_range_max;
347 /// MIDNAM information of the current track: Model name of MIDNAM file
348 std::string _model_name;
350 /// MIDNAM information of the current track: CustomDeviceMode
351 std::string _custom_device_mode;
353 typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
354 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
355 typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
357 boost::shared_ptr<ARDOUR::MidiModel> _model;
359 PgmChanges _pgm_changes;
361 ArdourCanvas::CanvasNote** _active_notes;
362 ArdourCanvas::Group* _note_group;
363 ARDOUR::MidiModel::DeltaCommand* _delta_command;
364 ARDOUR::MidiModel::DiffCommand* _diff_command;
366 MouseState _mouse_state;
369 typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
370 /// Currently selected CanvasNoteEvents
371 Selection _selection;
374 void time_sort_events ();
376 MidiCutBuffer* selection_as_cut_buffer () const;
378 /** New notes (created in the current command) which should be selected
379 * when they appear after the command is applied. */
380 std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
382 /** New notes (created in the current command) which should have visible velocity
383 * when they appear after the command is applied. */
384 std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
386 std::vector<NoteResizeData *> _resize_data;
388 /* connection used to connect to model's ContentChanged signal */
389 sigc::connection content_connection;
391 ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
392 Events::iterator _optimization_iterator;
394 void update_note (ArdourCanvas::CanvasNote*);
395 void update_hit (ArdourCanvas::CanvasHit*);
400 #endif /* __gtk_ardour_midi_region_view_h__ */