gtk2_ardour/midi_region_view.h

   1 /*
   2     Copyright (C) 2001-2011 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_patch_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 class EditNoteDialog;
  68
  69 class MidiRegionView : public RegionView
  70 {
  71 public:
  72         typedef Evoral::Note<Evoral::MusicalTime> NoteType;
  73         typedef Evoral::Sequence<Evoral::MusicalTime>::Notes Notes;
  74
  75         MidiRegionView (ArdourCanvas::Group *,
  76                         RouteTimeAxisView&,
  77                         boost::shared_ptr<ARDOUR::MidiRegion>,
  78                         double initial_samples_per_unit,
  79                         Gdk::Color const & basic_color);
  80
  81         MidiRegionView (const MidiRegionView& other);
  82         MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
  83
  84         ~MidiRegionView ();
  85
  86         virtual void init (Gdk::Color const & basic_color, bool wfd);
  87
  88         inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
  89         { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
  90
  91         inline MidiTimeAxisView* midi_view() const
  92         { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
  93
  94         inline MidiStreamView* midi_stream_view() const
  95         { return midi_view()->midi_view(); }
  96
  97         void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
  98                             Evoral::MusicalTime pos, Evoral::MusicalTime len);
  99         void step_sustain (Evoral::MusicalTime beats);
 100         void set_height (double);
 101         void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
 102
 103         inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
 104
 105         void set_frame_color();
 106         void color_handler ();
 107
 108         void show_step_edit_cursor (Evoral::MusicalTime pos);
 109         void move_step_edit_cursor (Evoral::MusicalTime pos);
 110         void hide_step_edit_cursor ();
 111         void set_step_edit_cursor_width (Evoral::MusicalTime beats);
 112
 113         void redisplay_model();
 114
 115         GhostRegion* add_ghost (TimeAxisView&);
 116
 117         void add_note(const boost::shared_ptr<NoteType> note, bool visible);
 118         void resolve_note(uint8_t note_num, double end_time);
 119
 120         void cut_copy_clear (Editing::CutCopyOp);
 121         void paste (framepos_t pos, float times, const MidiCutBuffer&);
 122
 123         /** Add a new patch change flag to the canvas.
 124          * @param patch the patch change to add
 125          * @param the text to display in the flag
 126          */
 127         void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext);
 128
 129         /** Look up the given time and channel in the 'automation' and set keys accordingly.
 130          * @param time the time of the patch change event
 131          * @param channel the MIDI channel of the event
 132          * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
 133          *        will be set according to the result of the lookup
 134          */
 135         void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
 136
 137         /** Change old_patch to new_patch.
 138          * @param old_patch the canvas patch change which is to be altered
 139          * @param new_patch new patch
 140          */
 141         void change_patch_change (ArdourCanvas::CanvasPatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
 142         void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::MusicalTime> const &);
 143
 144         void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::MusicalTime> const &);
 145         void move_patch_change (ArdourCanvas::CanvasPatchChange &, Evoral::MusicalTime);
 146         void delete_patch_change (ArdourCanvas::CanvasPatchChange *);
 147         void edit_patch_change (ArdourCanvas::CanvasPatchChange *);
 148
 149         /** Alter a given patch to be its predecessor in the MIDNAM file.
 150          */
 151         void previous_patch (ArdourCanvas::CanvasPatchChange &);
 152
 153         /** Alters a given patch to be its successor in the MIDNAM file.
 154          */
 155         void next_patch (ArdourCanvas::CanvasPatchChange &);
 156
 157         void previous_bank (ArdourCanvas::CanvasPatchChange &);
 158         void next_bank (ArdourCanvas::CanvasPatchChange &);
 159
 160         /** Displays all patch change events in the region as flags on the canvas.
 161          */
 162         void display_patch_changes();
 163
 164         /** Displays all system exclusive events in the region as flags on the canvas.
 165          */
 166         void display_sysexes();
 167
 168         void begin_write();
 169         void end_write();
 170         void extend_active_notes();
 171
 172         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
 173
 174         void start_note_diff_command (std::string name = "midi edit");
 175         void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
 176         void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
 177         void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
 178         void note_diff_remove_note (ArdourCanvas::CanvasNoteEvent* ev);
 179
 180         void apply_diff (bool as_subcommand = false);
 181         void abort_command();
 182
 183         void   note_entered(ArdourCanvas::CanvasNoteEvent* ev);
 184         void   note_left(ArdourCanvas::CanvasNoteEvent* ev);
 185         void   patch_entered (ArdourCanvas::CanvasPatchChange *);
 186         void   patch_left (ArdourCanvas::CanvasPatchChange *);
 187         void   note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
 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         void   delete_note (boost::shared_ptr<NoteType>);
 193         size_t selection_size() { return _selection.size(); }
 194         void   select_all_notes ();
 195         void   invert_selection ();
 196
 197         void move_selection(double dx, double dy, double cumulative_dy);
 198         void note_dropped (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::frameoffset_t, int8_t d_note);
 199
 200         void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
 201         void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
 202
 203         /** Return true iff the note is within the extent of the region.
 204          * @param visible will be set to true if the note is within the visible note range, false otherwise.
 205          */
 206         bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
 207
 208         /** Get the region position in pixels relative to session. */
 209         double get_position_pixels();
 210
 211         /** Get the region end position in pixels relative to session. */
 212         double get_end_position_pixels();
 213
 214         /** Begin resizing of some notes.
 215          * Called by CanvasMidiNote when resizing starts.
 216          * @param at_front which end of the note (true == note on, false == note off)
 217          */
 218         void begin_resizing(bool at_front);
 219
 220         void update_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
 221         void commit_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
 222
 223         /** Change the channel of the selection.
 224          * @param channel - the channel number of the new channel, zero-based
 225          */
 226         void change_channel(uint8_t channel);
 227
 228         enum MouseState {
 229                 None,
 230                 Pressed,
 231                 SelectTouchDragging,
 232                 SelectRectDragging,
 233                 AddDragging
 234         };
 235
 236         MouseState mouse_state() const { return _mouse_state; }
 237
 238         struct NoteResizeData {
 239                 ArdourCanvas::CanvasNote  *canvas_note;
 240                 ArdourCanvas::SimpleRect  *resize_rect;
 241         };
 242
 243         /** Snap a region relative pixel coordinate to pixel units.
 244          * @param x a pixel coordinate relative to region start
 245          * @return the snapped pixel coordinate relative to region start
 246          */
 247         double snap_to_pixel(double x);
 248
 249         /** Snap a region relative pixel coordinate to frame units.
 250          * @param x a pixel coordinate relative to region start
 251          * @return the snapped framepos_t coordinate relative to region start
 252          */
 253         framepos_t snap_pixel_to_frame(double x);
 254
 255         /** Convert a timestamp in beats into frames (both relative to region start) */
 256         framepos_t region_beats_to_region_frames(double beats) const;
 257         /** Convert a timestamp in beats into absolute frames */
 258         framepos_t region_beats_to_absolute_frames(double beats) const {
 259                 return _region->position() + region_beats_to_region_frames (beats);
 260         }
 261         /** Convert a timestamp in frames to beats (both relative to region start) */
 262         double region_frames_to_region_beats(framepos_t) const;
 263
 264         /** Convert a timestamp in beats measured from source start into absolute frames */
 265         framepos_t source_beats_to_absolute_frames(double beats) const;
 266         /** Convert a timestamp in beats measured from source start into region-relative frames */
 267         framepos_t source_beats_to_region_frames(double beats) const {
 268                 return source_beats_to_absolute_frames (beats) - _region->position();
 269         }
 270         /** Convert a timestamp in absolute frames to beats measured from source start*/
 271         double absolute_frames_to_source_beats(framepos_t) const;
 272
 273         void goto_previous_note (bool add_to_selection);
 274         void goto_next_note (bool add_to_selection);
 275         void change_note_lengths (bool, bool, Evoral::MusicalTime beats, bool start, bool end);
 276         void change_velocities (bool up, bool fine, bool allow_smush);
 277         void transpose (bool up, bool fine, bool allow_smush);
 278         void nudge_notes (bool forward);
 279         void channel_edit ();
 280
 281         void show_list_editor ();
 282
 283         void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
 284
 285         void enable_display (bool);
 286
 287         void set_channel_selector_scoped_note(ArdourCanvas::CanvasNoteEvent* note){ _channel_selection_scoped_note = note; }
 288         ArdourCanvas::CanvasNoteEvent* channel_selector_scoped_note(){  return _channel_selection_scoped_note; }
 289
 290         void trim_front_starting ();
 291         void trim_front_ending ();
 292
 293 protected:
 294         /** Allows derived types to specify their visibility requirements
 295          * to the TimeAxisViewItem parent class.
 296          */
 297         MidiRegionView (ArdourCanvas::Group *,
 298                         RouteTimeAxisView&,
 299                         boost::shared_ptr<ARDOUR::MidiRegion>,
 300                         double samples_per_unit,
 301                         Gdk::Color& basic_color,
 302                         TimeAxisViewItem::Visibility);
 303
 304         void region_resized (const PBD::PropertyChange&);
 305
 306         void set_flags (XMLNode *);
 307         void store_flags ();
 308
 309         void reset_width_dependent_items (double pixel_width);
 310
 311         void parameter_changed (std::string const & p);
 312
 313 private:
 314
 315         /** Emitted when the selection has been cleared in one MidiRegionView */
 316         static PBD::Signal1<void, MidiRegionView*> SelectionCleared;
 317         PBD::ScopedConnection _selection_cleared_connection;
 318         void selection_cleared (MidiRegionView *);
 319
 320         friend class EditNoteDialog;
 321
 322         void create_note_at(double x, double y, double length, bool, bool);
 323
 324         /** Play the NoteOn event of the given note immediately
 325          * and schedule the playback of the corresponding NoteOff event.
 326          */
 327         void play_midi_note(boost::shared_ptr<NoteType> note);
 328         void play_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
 329
 330         /** Play the NoteOff-Event of the given note immediately
 331          * (scheduled by @ref play_midi_note()).
 332          */
 333         bool play_midi_note_off(boost::shared_ptr<NoteType> note);
 334
 335         void clear_events();
 336
 337         bool canvas_event(GdkEvent* ev);
 338         bool note_canvas_event(GdkEvent* ev);
 339
 340         void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
 341         void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
 342
 343         void change_note_channel (ArdourCanvas::CanvasNoteEvent *, int8_t, bool relative=false);
 344         void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
 345         void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
 346         void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
 347         void change_note_length (ArdourCanvas::CanvasNoteEvent *, ARDOUR::MidiModel::TimeType);
 348         void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
 349                        ARDOUR::MidiModel::TimeType end_delta);
 350
 351         void clear_selection_except (ArdourCanvas::CanvasNoteEvent* ev, bool signal = true);
 352         void clear_selection (bool signal = true) { clear_selection_except (0, signal); }
 353         void update_drag_selection (double last_x, double x, double last_y, double y, bool extend);
 354
 355         void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
 356         void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
 357
 358         void show_verbose_cursor (std::string const &, double, double) const;
 359         void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
 360
 361         int8_t   _force_channel;
 362         uint16_t _last_channel_selection;
 363         uint8_t  _current_range_min;
 364         uint8_t  _current_range_max;
 365
 366         /// MIDNAM information of the current track: Model name of MIDNAM file
 367         std::string _model_name;
 368
 369         /// MIDNAM information of the current track: CustomDeviceMode
 370         std::string _custom_device_mode;
 371
 372         typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
 373         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasPatchChange> > PatchChanges;
 374         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
 375
 376         boost::shared_ptr<ARDOUR::MidiModel> _model;
 377         Events                               _events;
 378         PatchChanges                         _patch_changes;
 379         SysExes                              _sys_exes;
 380         ArdourCanvas::CanvasNote**           _active_notes;
 381         ArdourCanvas::Group*                 _note_group;
 382         ARDOUR::MidiModel::NoteDiffCommand*  _note_diff_command;
 383         ArdourCanvas::CanvasNote*            _ghost_note;
 384         double                               _last_ghost_x;
 385         double                               _last_ghost_y;
 386         double                               _drag_start_x;
 387         double                               _drag_start_y;
 388         double                               _last_x;
 389         double                               _last_y;
 390         ArdourCanvas::SimpleRect*            _drag_rect;
 391         ArdourCanvas::SimpleRect*            _step_edit_cursor;
 392         Evoral::MusicalTime                  _step_edit_cursor_width;
 393         Evoral::MusicalTime                  _step_edit_cursor_position;
 394         ArdourCanvas::CanvasNoteEvent*       _channel_selection_scoped_note;
 395
 396
 397         /** A group used to temporarily reparent _note_group to during start trims, so
 398          *  that the notes don't move with the parent region view.
 399          */
 400         ArdourCanvas::Group*                 _temporary_note_group;
 401
 402         MouseState _mouse_state;
 403         int _pressed_button;
 404
 405         typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
 406         /// Currently selected CanvasNoteEvents
 407         Selection _selection;
 408
 409         bool _sort_needed;
 410         void time_sort_events ();
 411
 412         MidiCutBuffer* selection_as_cut_buffer () const;
 413
 414         /** New notes (created in the current command) which should be selected
 415          * when they appear after the command is applied. */
 416         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 417
 418         /** New notes (created in the current command) which should have visible velocity
 419          * when they appear after the command is applied. */
 420         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 421
 422         std::vector<NoteResizeData *> _resize_data;
 423
 424         /** connection used to connect to model's ContentChanged signal */
 425         PBD::ScopedConnection content_connection;
 426
 427         ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
 428         Events::iterator _optimization_iterator;
 429
 430         void update_note (ArdourCanvas::CanvasNote *, bool update_ghost_regions = true);
 431         double update_hit (ArdourCanvas::CanvasHit *);
 432         void create_ghost_note (double, double);
 433         void update_ghost_note (double, double);
 434
 435         MidiListEditor* _list_editor;
 436         bool _no_sound_notes;
 437
 438         PBD::ScopedConnection note_delete_connection;
 439         void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
 440
 441         void snap_changed ();
 442         PBD::ScopedConnection snap_changed_connection;
 443
 444         bool motion (GdkEventMotion*);
 445         bool scroll (GdkEventScroll*);
 446         bool key_press (GdkEventKey*);
 447         bool key_release (GdkEventKey*);
 448         bool button_press (GdkEventButton*);
 449         bool button_release (GdkEventButton*);
 450         bool enter_notify (GdkEventCrossing*);
 451         bool leave_notify (GdkEventCrossing*);
 452
 453         void drop_down_keys ();
 454         void maybe_select_by_position (GdkEventButton* ev, double x, double y);
 455         void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
 456
 457         void display_patch_changes_on_channel (uint8_t);
 458
 459         void connect_to_diskstream ();
 460         void data_recorded (boost::shared_ptr<ARDOUR::MidiBuffer>, boost::weak_ptr<ARDOUR::MidiSource>);
 461
 462         void remove_ghost_note ();
 463         void mouse_mode_changed ();
 464         double _last_event_x;
 465         double _last_event_y;
 466
 467         framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
 468
 469         PBD::ScopedConnection _mouse_mode_connection;
 470
 471         Gdk::Cursor* _pre_enter_cursor;
 472 };
 473
 474
 475 #endif /* __gtk_ardour_midi_region_view_h__ */