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