gtk2_ardour/midi_region_view.h

   1 /*
   2  * Copyright (C) 2006-2015 David Robillard <d@drobilla.net>
   3  * Copyright (C) 2008-2012 Hans Baier <hansfbaier@googlemail.com>
   4  * Copyright (C) 2008-2017 Paul Davis <paul@linuxaudiosystems.com>
   5  * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
   6  * Copyright (C) 2015-2016 Tim Mayberry <mojofunk@gmail.com>
   7  * Copyright (C) 2015-2017 Nick Mainsbridge <mainsbridge@gmail.com>
   8  * Copyright (C) 2015-2017 Robin Gareus <robin@gareus.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #ifndef __gtk_ardour_midi_region_view_h__
  26 #define __gtk_ardour_midi_region_view_h__
  27
  28 #include <string>
  29 #include <vector>
  30 #include <stdint.h>
  31
  32 #include "pbd/signals.h"
  33
  34 #include "ardour/midi_model.h"
  35 #include "ardour/types.h"
  36
  37 #include "editing.h"
  38 #include "region_view.h"
  39 #include "midi_time_axis.h"
  40 #include "time_axis_view_item.h"
  41 #include "automation_line.h"
  42 #include "enums.h"
  43
  44 namespace ARDOUR {
  45         class MidiRegion;
  46         class MidiModel;
  47         class Filter;
  48 };
  49
  50 namespace MIDI {
  51         namespace Name {
  52                 struct PatchPrimaryKey;
  53         };
  54 };
  55
  56 class SysEx;
  57 class NoteBase;
  58 class Note;
  59 class Hit;
  60 class MidiTimeAxisView;
  61 class GhostRegion;
  62 class AutomationTimeAxisView;
  63 class AutomationRegionView;
  64 class MidiCutBuffer;
  65 class MidiListEditor;
  66 class EditNoteDialog;
  67 class PatchChange;
  68 class ItemCounts;
  69 class CursorContext;
  70
  71 class MidiRegionView : public RegionView
  72 {
  73 public:
  74         typedef Evoral::Note<Temporal::Beats> NoteType;
  75         typedef Evoral::Sequence<Temporal::Beats>::Notes Notes;
  76
  77         MidiRegionView (ArdourCanvas::Container*              parent,
  78                         RouteTimeAxisView&                    tv,
  79                         boost::shared_ptr<ARDOUR::MidiRegion> r,
  80                         double                                samples_per_pixel,
  81                         uint32_t                              basic_color);
  82
  83         MidiRegionView (ArdourCanvas::Container*              parent,
  84                         RouteTimeAxisView&                    tv,
  85                         boost::shared_ptr<ARDOUR::MidiRegion> r,
  86                         double                                samples_per_pixel,
  87                         uint32_t                              basic_color,
  88                         bool                                  recording,
  89                         Visibility                            visibility);
  90
  91
  92         MidiRegionView (const MidiRegionView& other);
  93         MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
  94
  95         ~MidiRegionView ();
  96
  97         void init (bool wfd);
  98
  99         const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const;
 100
 101         inline MidiTimeAxisView* midi_view() const
 102         { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
 103
 104         inline MidiStreamView* midi_stream_view() const
 105         { return midi_view()->midi_view(); }
 106
 107         void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
 108                             Temporal::Beats pos, Temporal::Beats len);
 109         void step_sustain (Temporal::Beats beats);
 110         void set_height (double);
 111         void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
 112
 113         inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
 114
 115         uint32_t get_fill_color() const;
 116         void color_handler ();
 117
 118         void show_step_edit_cursor (Temporal::Beats pos);
 119         void move_step_edit_cursor (Temporal::Beats pos);
 120         void hide_step_edit_cursor ();
 121         void set_step_edit_cursor_width (Temporal::Beats beats);
 122
 123         void redisplay_model();
 124
 125         GhostRegion* add_ghost (TimeAxisView&);
 126
 127         NoteBase* add_note(const boost::shared_ptr<NoteType> note, bool visible);
 128         void resolve_note(uint8_t note_num, Temporal::Beats end_time);
 129
 130         void cut_copy_clear (Editing::CutCopyOp);
 131         bool paste (samplepos_t pos, const ::Selection& selection, PasteContext& ctx, const int32_t sub_num);
 132         void paste_internal (samplepos_t pos, unsigned paste_count, float times, const MidiCutBuffer&);
 133
 134         void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext, bool);
 135         void remove_canvas_patch_change (PatchChange* pc);
 136
 137         /** Look up the given time and channel in the 'automation' and set keys accordingly.
 138          * @param time the time of the patch change event
 139          * @param channel the MIDI channel of the event
 140          * @param key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
 141          *        will be set according to the result of the lookup
 142          */
 143         void get_patch_key_at (Temporal::Beats time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key) const;
 144
 145         /** Convert a given PatchChange into a PatchPrimaryKey
 146          */
 147         MIDI::Name::PatchPrimaryKey patch_change_to_patch_key (ARDOUR::MidiModel::PatchChangePtr);
 148
 149         /** Change old_patch to new_patch.
 150          * @param old_patch the canvas patch change which is to be altered
 151          * @param new_patch new patch
 152          */
 153         void change_patch_change (PatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
 154         void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Temporal::Beats> const &);
 155
 156         void add_patch_change (samplecnt_t, Evoral::PatchChange<Temporal::Beats> const &);
 157         void move_patch_change (PatchChange &, Temporal::Beats);
 158         void delete_patch_change (PatchChange *);
 159         void edit_patch_change (PatchChange *);
 160
 161         void delete_sysex (SysEx*);
 162
 163         /** Change a patch to the next or previous bank/program.
 164          *
 165          * @param patch The patch-change instance (canvas item)
 166          * @param bank If true, step bank, otherwise, step program.
 167          * @param delta Amount to adjust number.
 168          */
 169         void step_patch (PatchChange& patch, bool bank, int delta);
 170
 171         /** Displays all patch change events in the region as flags on the canvas.
 172          */
 173         void display_patch_changes();
 174
 175         /** Displays all system exclusive events in the region as flags on the canvas.
 176          */
 177         void display_sysexes();
 178
 179         void begin_write();
 180         void end_write();
 181         void extend_active_notes();
 182
 183         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
 184
 185         void start_note_diff_command (std::string name = "midi edit");
 186         void note_diff_add_change (NoteBase* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
 187         void note_diff_add_change (NoteBase* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Temporal::Beats val);
 188         void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
 189         void note_diff_remove_note (NoteBase* ev);
 190
 191         void apply_diff (bool as_subcommand = false, bool was_copy = false);
 192         void abort_command();
 193
 194         void   note_entered(NoteBase* ev);
 195         void   note_left(NoteBase* ev);
 196         void   patch_entered (PatchChange *);
 197         void   patch_left (PatchChange *);
 198         void   sysex_entered (SysEx* p);
 199         void   sysex_left (SysEx* p);
 200         void   note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
 201         void   unique_select(NoteBase* ev);
 202         void   note_selected(NoteBase* ev, bool add, bool extend=false);
 203         void   note_deselected(NoteBase* ev);
 204         void   delete_selection();
 205         void   delete_note (boost::shared_ptr<NoteType>);
 206         size_t selection_size() { return _selection.size(); }
 207         void   select_all_notes ();
 208         void   select_range(samplepos_t start, samplepos_t end);
 209         void   invert_selection ();
 210
 211         Temporal::Beats earliest_in_selection ();
 212         void move_selection(double dx, double dy, double cumulative_dy);
 213         void note_dropped (NoteBase* ev, double d_qn, int8_t d_note, bool copy);
 214         NoteBase* copy_selection (NoteBase* primary);
 215         void move_copies(double dx_qn, double dy, double cumulative_dy);
 216
 217         void select_notes (std::list<Evoral::event_id_t>);
 218         void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
 219         void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
 220
 221         /** Test if a note is within this region's range
 222          *
 223          * @param note the note to test
 224          * @param visible will be set to true if the note is within the visible note range, false otherwise.
 225          * @return true iff the note is within the (time) extent of the region.
 226          */
 227         bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
 228
 229         /** Get the region position in pixels relative to session. */
 230         double get_position_pixels();
 231
 232         /** Get the region end position in pixels relative to session. */
 233         double get_end_position_pixels();
 234
 235         /** Begin resizing of some notes.
 236          * Called by CanvasMidiNote when resizing starts.
 237          * @param at_front which end of the note (true == note on, false == note off)
 238          */
 239         void begin_resizing(bool at_front);
 240
 241         void update_resizing (NoteBase* primary, bool at_front, double delta_x, bool relative, double snap_delta, bool with_snap);
 242         void commit_resizing (NoteBase* primary, bool at_front, double delat_x, bool relative, double snap_delta, bool with_snap);
 243         void abort_resizing ();
 244
 245         /** Change the channel of the selection.
 246          * @param channel - the channel number of the new channel, zero-based
 247          */
 248         void change_channel(uint8_t channel);
 249
 250         enum MouseState {
 251                 None,
 252                 Pressed,
 253                 SelectTouchDragging,
 254                 SelectRectDragging,
 255                 SelectVerticalDragging,
 256                 AddDragging
 257         };
 258
 259         MouseState mouse_state() const { return _mouse_state; }
 260
 261         struct NoteResizeData {
 262                 Note                     *note;
 263                 ArdourCanvas::Rectangle  *resize_rect;
 264         };
 265
 266         /** Snap a region relative pixel coordinate to pixel units.
 267          * @param x a pixel coordinate relative to region start
 268          * @param ensure_snap do not use magnetic snap (required for snap delta calculation)
 269          * @return the snapped pixel coordinate relative to region start
 270          */
 271         double snap_to_pixel(double x, bool ensure_snap = false);
 272
 273         /** Snap a region relative pixel coordinate to sample units.
 274          * @param x a pixel coordinate relative to region start
 275          * @param ensure_snap ignore SnapOff and magnetic snap.
 276          * Required for inverting snap logic with modifier keys and snap delta calculation.
 277          * @return the snapped samplepos_t coordinate relative to region start
 278          */
 279         samplepos_t snap_pixel_to_sample(double x, bool ensure_snap = false);
 280
 281         /** Convert a timestamp in beats into samples (both relative to region position) */
 282         samplepos_t region_beats_to_region_samples(Temporal::Beats beats) const;
 283         /** Convert a timestamp in beats into absolute samples */
 284         samplepos_t region_beats_to_absolute_samples(Temporal::Beats beats) const {
 285                 return _region->position() + region_beats_to_region_samples (beats);
 286         }
 287         /** Convert a timestamp in samples to beats (both relative to region position) */
 288         Temporal::Beats region_samples_to_region_beats(samplepos_t) const;
 289         double region_samples_to_region_beats_double(samplepos_t) const;
 290
 291         /** Convert a timestamp in beats measured from source start into absolute samples */
 292         samplepos_t source_beats_to_absolute_samples(Temporal::Beats beats) const;
 293         /** Convert a timestamp in beats measured from source start into region-relative samples */
 294         samplepos_t source_beats_to_region_samples(Temporal::Beats beats) const {
 295                 return source_beats_to_absolute_samples (beats) - _region->position();
 296         }
 297         /** Convert a timestamp in absolute samples to beats measured from source start*/
 298         Temporal::Beats absolute_samples_to_source_beats(samplepos_t) const;
 299
 300         ARDOUR::BeatsSamplesConverter const & region_relative_time_converter () const {
 301                 return _region_relative_time_converter;
 302         }
 303
 304         ARDOUR::BeatsSamplesConverter const & source_relative_time_converter () const {
 305                 return _source_relative_time_converter;
 306         }
 307
 308         ARDOUR::DoubleBeatsSamplesConverter const & region_relative_time_converter_double () const {
 309                 return _region_relative_time_converter_double;
 310         }
 311
 312         double session_relative_qn (double qn) const;
 313
 314         void goto_previous_note (bool add_to_selection);
 315         void goto_next_note (bool add_to_selection);
 316         void change_note_lengths (bool, bool, Temporal::Beats beats, bool start, bool end);
 317         void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
 318         void transpose (bool up, bool fine, bool allow_smush);
 319         void nudge_notes (bool forward, bool fine);
 320         void channel_edit ();
 321         void velocity_edit ();
 322
 323         void show_list_editor ();
 324
 325         typedef std::set<NoteBase*> Selection;
 326         Selection selection () const {
 327                 return _selection;
 328         }
 329
 330         void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
 331
 332         void enable_display (bool);
 333
 334         void set_channel_selector_scoped_note(NoteBase* note){ _channel_selection_scoped_note = note; }
 335         NoteBase* channel_selector_scoped_note(){  return _channel_selection_scoped_note; }
 336
 337         void trim_front_starting ();
 338         void trim_front_ending ();
 339
 340         /** Add a note to the model, and the view, at a canvas (click) coordinate.
 341          * \param t time in samples relative to the position of the region
 342          * \param y vertical position in pixels
 343          * \param length duration of the note in beats
 344          * \param state the keyboard modifier mask for the canvas event (click).
 345          * \param shift_snap true alters snap behavior to round down always (false if the gui has already done that).
 346          */
 347         void create_note_at (samplepos_t t, double y, Temporal::Beats length, uint32_t state, bool shift_snap);
 348
 349         /** An external request to clear the note selection, remove MRV from editor
 350          * selection.
 351          */
 352         void clear_selection ();
 353
 354         ARDOUR::InstrumentInfo& instrument_info() const;
 355
 356         void note_deleted (NoteBase*);
 357
 358         void show_verbose_cursor_for_new_note_value(boost::shared_ptr<NoteType> current_note,
 359                                                     uint8_t new_note) const;
 360
 361 protected:
 362         void region_resized (const PBD::PropertyChange&);
 363
 364         void set_flags (XMLNode *);
 365         void store_flags ();
 366
 367         void reset_width_dependent_items (double pixel_width);
 368
 369         void parameter_changed (std::string const & p);
 370
 371 private:
 372
 373         friend class MidiRubberbandSelectDrag;
 374         friend class MidiVerticalSelectDrag;
 375         friend class NoteDrag;
 376         friend class NoteCreateDrag;
 377         friend class HitCreateDrag;
 378         friend class MidiGhostRegion;
 379
 380         friend class EditNoteDialog;
 381
 382         /** Play the NoteOn event of the given note immediately
 383          * and schedule the playback of the corresponding NoteOff event.
 384          */
 385         void play_midi_note (boost::shared_ptr<NoteType> note);
 386         void start_playing_midi_note (boost::shared_ptr<NoteType> note);
 387         void start_playing_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
 388
 389         /** Clear the note selection of just this midi region
 390          */
 391         void clear_selection_internal ();
 392
 393         void clear_editor_note_selection ();
 394
 395         void clear_events ();
 396
 397         bool canvas_group_event(GdkEvent* ev);
 398         bool note_canvas_event(GdkEvent* ev);
 399
 400         void midi_channel_mode_changed ();
 401         PBD::ScopedConnection _channel_mode_changed_connection;
 402         void instrument_settings_changed ();
 403         PBD::ScopedConnection _instrument_changed_connection;
 404
 405         void change_note_channel (NoteBase *, int8_t, bool relative=false);
 406         void change_note_velocity(NoteBase* ev, int8_t vel, bool relative=false);
 407         void change_note_note(NoteBase* ev, int8_t note, bool relative=false);
 408         void change_note_time(NoteBase* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
 409         void change_note_length (NoteBase *, ARDOUR::MidiModel::TimeType);
 410         void trim_note(NoteBase* ev, ARDOUR::MidiModel::TimeType start_delta,
 411                        ARDOUR::MidiModel::TimeType end_delta);
 412
 413         void update_drag_selection (samplepos_t start, samplepos_t end, double y0, double y1, bool extend);
 414         void update_vertical_drag_selection (double last_y, double y, bool extend);
 415
 416         void add_to_selection (NoteBase*);
 417         void remove_from_selection (NoteBase*);
 418
 419         std::string get_note_name (boost::shared_ptr<NoteType> note, uint8_t note_value) const;
 420
 421         void show_verbose_cursor (std::string const &, double, double) const;
 422         void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
 423
 424         uint8_t get_velocity_for_add (ARDOUR::MidiModel::TimeType time) const;
 425
 426         uint8_t  _current_range_min;
 427         uint8_t  _current_range_max;
 428
 429         typedef boost::unordered_map<boost::shared_ptr<NoteType>, NoteBase*>                             Events;
 430         typedef boost::unordered_map<ARDOUR::MidiModel::PatchChangePtr, boost::shared_ptr<PatchChange> > PatchChanges;
 431         typedef boost::unordered_map<ARDOUR::MidiModel::constSysExPtr, boost::shared_ptr<SysEx> >        SysExes;
 432         typedef std::vector<NoteBase*> CopyDragEvents;
 433
 434         ARDOUR::BeatsSamplesConverter _region_relative_time_converter;
 435         ARDOUR::BeatsSamplesConverter _source_relative_time_converter;
 436         ARDOUR::DoubleBeatsSamplesConverter _region_relative_time_converter_double;
 437
 438         boost::shared_ptr<ARDOUR::MidiModel> _model;
 439         Events                               _events;
 440         CopyDragEvents                       _copy_drag_events;
 441         PatchChanges                         _patch_changes;
 442         SysExes                              _sys_exes;
 443         Note**                               _active_notes;
 444         ArdourCanvas::Container*             _note_group;
 445         ARDOUR::MidiModel::NoteDiffCommand*  _note_diff_command;
 446         NoteBase*                            _ghost_note;
 447         double                               _last_ghost_x;
 448         double                               _last_ghost_y;
 449         ArdourCanvas::Rectangle*             _step_edit_cursor;
 450         Temporal::Beats                      _step_edit_cursor_width;
 451         Temporal::Beats                      _step_edit_cursor_position;
 452         NoteBase*                            _channel_selection_scoped_note;
 453
 454         MouseState _mouse_state;
 455         int _pressed_button;
 456
 457         /** Currently selected NoteBase objects */
 458         Selection _selection;
 459
 460         MidiCutBuffer* selection_as_cut_buffer () const;
 461
 462         /** New notes (created in the current command) which should be selected
 463          * when they appear after the command is applied. */
 464         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 465
 466         /** Notes that should be selected when the model is redisplayed. */
 467         std::set<Evoral::event_id_t> _pending_note_selection;
 468
 469         /** New notes (created in the current command) which should have visible velocity
 470          * when they appear after the command is applied. */
 471         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 472
 473         std::vector<NoteResizeData *> _resize_data;
 474
 475         /** connection used to connect to model's ContentChanged signal */
 476         PBD::ScopedConnection content_connection;
 477
 478         NoteBase* find_canvas_note (boost::shared_ptr<NoteType>);
 479         NoteBase* find_canvas_note (Evoral::event_id_t id);
 480         Events::iterator _optimization_iterator;
 481
 482         boost::shared_ptr<PatchChange> find_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr p);
 483         boost::shared_ptr<SysEx> find_canvas_sys_ex (ARDOUR::MidiModel::SysExPtr s);
 484
 485         void update_note (NoteBase*, bool update_ghost_regions = true);
 486         void update_sustained (Note *, bool update_ghost_regions = true);
 487         void update_hit (Hit *, bool update_ghost_regions = true);
 488
 489         void create_ghost_note (double, double, uint32_t state);
 490         void update_ghost_note (double, double, uint32_t state);
 491
 492         MidiListEditor* _list_editor;
 493         bool _no_sound_notes;
 494
 495         void snap_changed ();
 496         PBD::ScopedConnection snap_changed_connection;
 497
 498         bool motion (GdkEventMotion*);
 499         bool scroll (GdkEventScroll*);
 500         bool key_press (GdkEventKey*);
 501         bool key_release (GdkEventKey*);
 502         bool button_press (GdkEventButton*);
 503         bool button_release (GdkEventButton*);
 504         bool enter_notify (GdkEventCrossing*);
 505         bool leave_notify (GdkEventCrossing*);
 506
 507         void drop_down_keys ();
 508         void maybe_select_by_position (GdkEventButton* ev, double x, double y);
 509         void get_events (Events& e, Evoral::Sequence<Temporal::Beats>::NoteOperator op, uint8_t val, int chan_mask = 0);
 510
 511         void display_patch_changes_on_channel (uint8_t, bool);
 512
 513         void connect_to_diskstream ();
 514         void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
 515
 516         /** Get grid type as beats, or default to 1 if not snapped to beats. */
 517         Temporal::Beats get_grid_beats(samplepos_t pos) const;
 518
 519         void remove_ghost_note ();
 520         void mouse_mode_changed ();
 521         void enter_internal (uint32_t state);
 522         void leave_internal ();
 523         void hide_verbose_cursor ();
 524
 525         samplecnt_t _last_display_zoom;
 526
 527         double    _last_event_x;
 528         double    _last_event_y;
 529         bool      _grabbed_keyboard;
 530         bool      _entered;
 531         NoteBase* _entered_note;
 532
 533         bool _mouse_changed_selection;
 534
 535         Gtkmm2ext::Color _patch_change_outline;
 536         Gtkmm2ext::Color _patch_change_fill;
 537
 538         Temporal::Beats snap_sample_to_grid_underneath (samplepos_t p, int32_t divisions, bool shift_snap) const;
 539
 540         PBD::ScopedConnection _mouse_mode_connection;
 541
 542         boost::shared_ptr<CursorContext> _press_cursor_ctx;
 543
 544         ARDOUR::ChannelMode get_channel_mode() const;
 545         uint16_t get_selected_channels () const;
 546
 547         inline double contents_height() const { return (_height - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE - 2); }
 548         inline double contents_note_range () const { return (double)(_current_range_max - _current_range_min + 1); }
 549         inline double note_height() const { return contents_height() / contents_note_range(); }
 550
 551         double note_to_y (uint8_t note) const;
 552         uint8_t y_to_note (double y) const;
 553 };
 554
 555
 556 #endif /* __gtk_ardour_midi_region_view_h__ */