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<Evoral::Beats> NoteType;
  69         typedef Evoral::Sequence<Evoral::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                             Evoral::Beats pos, Evoral::Beats len);
 103         void step_sustain (Evoral::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 (Evoral::Beats pos);
 113         void move_step_edit_cursor (Evoral::Beats pos);
 114         void hide_step_edit_cursor ();
 115         void set_step_edit_cursor_width (Evoral::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, Evoral::Beats end_time);
 123
 124         void cut_copy_clear (Editing::CutCopyOp);
 125         bool paste (framepos_t pos, const ::Selection& selection, PasteContext& ctx, const int32_t sub_num);
 126         void paste_internal (framepos_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
 130         /** Look up the given time and channel in the 'automation' and set keys accordingly.
 131          * @param time the time of the patch change event
 132          * @param channel the MIDI channel of the event
 133          * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
 134          *        will be set according to the result of the lookup
 135          */
 136         void get_patch_key_at (Evoral::Beats time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key) const;
 137
 138         /** Convert a given PatchChange into a PatchPrimaryKey
 139          */
 140         MIDI::Name::PatchPrimaryKey patch_change_to_patch_key (ARDOUR::MidiModel::PatchChangePtr);
 141
 142         /** Change old_patch to new_patch.
 143          * @param old_patch the canvas patch change which is to be altered
 144          * @param new_patch new patch
 145          */
 146         void change_patch_change (PatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
 147         void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::Beats> const &);
 148
 149         void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::Beats> const &);
 150         void move_patch_change (PatchChange &, Evoral::Beats);
 151         void delete_patch_change (PatchChange *);
 152         void edit_patch_change (PatchChange *);
 153
 154         void delete_sysex (SysEx*);
 155
 156         /** Change a patch to the next or previous bank/program.
 157          * @param bank If true, step bank, otherwise, step program.
 158          * @param delta Amount to adjust number.
 159          */
 160         void step_patch (PatchChange& patch, bool bank, int delta);
 161
 162         /** Displays all patch change events in the region as flags on the canvas.
 163          */
 164         void display_patch_changes();
 165
 166         /** Displays all system exclusive events in the region as flags on the canvas.
 167          */
 168         void display_sysexes();
 169
 170         void begin_write();
 171         void end_write();
 172         void extend_active_notes();
 173
 174         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
 175
 176         void start_note_diff_command (std::string name = "midi edit");
 177         void note_diff_add_change (NoteBase* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
 178         void note_diff_add_change (NoteBase* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::Beats val);
 179         void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
 180         void note_diff_remove_note (NoteBase* ev);
 181
 182         void apply_diff (bool as_subcommand = false);
 183         void abort_command();
 184
 185         void   note_entered(NoteBase* ev);
 186         void   note_left(NoteBase* ev);
 187         void   patch_entered (PatchChange *);
 188         void   patch_left (PatchChange *);
 189         void   sysex_entered (SysEx* p);
 190         void   sysex_left (SysEx* p);
 191         void   note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
 192         void   unique_select(NoteBase* ev);
 193         void   note_selected(NoteBase* ev, bool add, bool extend=false);
 194         void   note_deselected(NoteBase* ev);
 195         void   delete_selection();
 196         void   delete_note (boost::shared_ptr<NoteType>);
 197         size_t selection_size() { return _selection.size(); }
 198         void   select_all_notes ();
 199         void   select_range(framepos_t start, framepos_t end);
 200         void   invert_selection ();
 201
 202         void move_selection(double dx, double dy, double cumulative_dy);
 203         void note_dropped (NoteBase* ev, ARDOUR::frameoffset_t, int8_t d_note);
 204
 205         void select_notes (std::list<Evoral::event_id_t>);
 206         void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
 207         void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
 208
 209         /** Return true iff the note is within the extent of the region.
 210          * @param visible will be set to true if the note is within the visible note range, false otherwise.
 211          */
 212         bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
 213
 214         /** Get the region position in pixels relative to session. */
 215         double get_position_pixels();
 216
 217         /** Get the region end position in pixels relative to session. */
 218         double get_end_position_pixels();
 219
 220         /** Begin resizing of some notes.
 221          * Called by CanvasMidiNote when resizing starts.
 222          * @param at_front which end of the note (true == note on, false == note off)
 223          */
 224         void begin_resizing(bool at_front);
 225
 226         void update_resizing (NoteBase* primary, bool at_front, double delta_x, bool relative, double snap_delta, bool with_snap);
 227         void commit_resizing (NoteBase* primary, bool at_front, double delat_x, bool relative, double snap_delta, bool with_snap);
 228         void abort_resizing ();
 229
 230         /** Change the channel of the selection.
 231          * @param channel - the channel number of the new channel, zero-based
 232          */
 233         void change_channel(uint8_t channel);
 234
 235         enum MouseState {
 236                 None,
 237                 Pressed,
 238                 SelectTouchDragging,
 239                 SelectRectDragging,
 240                 SelectVerticalDragging,
 241                 AddDragging
 242         };
 243
 244         MouseState mouse_state() const { return _mouse_state; }
 245
 246         struct NoteResizeData {
 247                 Note                     *note;
 248                 ArdourCanvas::Rectangle  *resize_rect;
 249         };
 250
 251         /** Snap a region relative pixel coordinate to pixel units.
 252          * @param x a pixel coordinate relative to region start
 253          * @param ensure_snap do not use magnetic snap (required for snap delta calculation)
 254          * @return the snapped pixel coordinate relative to region start
 255          */
 256         double snap_to_pixel(double x, bool ensure_snap = false);
 257
 258         /** Snap a region relative pixel coordinate to frame units.
 259          * @param x a pixel coordinate relative to region start
 260          * @param ensure_snap ignore SnapOff and magnetic snap.
 261          * Required for inverting snap logic with modifier keys and snap delta calculation.
 262          * @return the snapped framepos_t coordinate relative to region start
 263          */
 264         framepos_t snap_pixel_to_sample(double x, bool ensure_snap = false);
 265
 266         /** Convert a timestamp in beats into frames (both relative to region position) */
 267         framepos_t region_beats_to_region_frames(Evoral::Beats beats) const;
 268         /** Convert a timestamp in beats into absolute frames */
 269         framepos_t region_beats_to_absolute_frames(Evoral::Beats beats) const {
 270                 return _region->position() + region_beats_to_region_frames (beats);
 271         }
 272         /** Convert a timestamp in frames to beats (both relative to region position) */
 273         Evoral::Beats region_frames_to_region_beats(framepos_t) const;
 274         double region_frames_to_region_beats_double(framepos_t) const;
 275
 276         /** Convert a timestamp in beats measured from source start into absolute frames */
 277         framepos_t source_beats_to_absolute_frames(Evoral::Beats beats) const;
 278         /** Convert a timestamp in beats measured from source start into region-relative frames */
 279         framepos_t source_beats_to_region_frames(Evoral::Beats beats) const {
 280                 return source_beats_to_absolute_frames (beats) - _region->position();
 281         }
 282         /** Convert a timestamp in absolute frames to beats measured from source start*/
 283         Evoral::Beats absolute_frames_to_source_beats(framepos_t) const;
 284
 285         ARDOUR::BeatsFramesConverter const & region_relative_time_converter () const {
 286                 return _region_relative_time_converter;
 287         }
 288
 289         ARDOUR::BeatsFramesConverter const & source_relative_time_converter () const {
 290                 return _source_relative_time_converter;
 291         }
 292
 293         ARDOUR::DoubleBeatsFramesConverter const & region_relative_time_converter_double () const {
 294                 return _region_relative_time_converter_double;
 295         }
 296
 297         void goto_previous_note (bool add_to_selection);
 298         void goto_next_note (bool add_to_selection);
 299         void change_note_lengths (bool, bool, Evoral::Beats beats, bool start, bool end);
 300         void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
 301         void transpose (bool up, bool fine, bool allow_smush);
 302         void nudge_notes (bool forward, bool fine);
 303         void channel_edit ();
 304         void velocity_edit ();
 305
 306         void show_list_editor ();
 307
 308         typedef std::set<NoteBase*> Selection;
 309         Selection selection () const {
 310                 return _selection;
 311         }
 312
 313         void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
 314
 315         void enable_display (bool);
 316
 317         void set_channel_selector_scoped_note(NoteBase* note){ _channel_selection_scoped_note = note; }
 318         NoteBase* channel_selector_scoped_note(){  return _channel_selection_scoped_note; }
 319
 320         void trim_front_starting ();
 321         void trim_front_ending ();
 322
 323         /** Add a note to the model, and the view, at a canvas (click) coordinate.
 324          * \param t time in frames relative to the position of the region
 325          * \param y vertical position in pixels
 326          * \param length duration of the note in beats
 327          * \param state the keyboard modifier mask for the canvas event (click).
 328          * \param shift_snap true alters snap behavior to round down always (false if the gui has already done that).
 329          */
 330         void create_note_at (framepos_t t, double y, Evoral::Beats length, uint32_t state, bool shift_snap);
 331
 332         /** An external request to clear the note selection, remove MRV from editor
 333          * selection.
 334          */
 335         void clear_selection ();
 336
 337         ARDOUR::InstrumentInfo& instrument_info() const;
 338
 339         void note_deleted (NoteBase*);
 340
 341         void show_verbose_cursor_for_new_note_value(boost::shared_ptr<NoteType> current_note,
 342                                                     uint8_t new_note) const;
 343
 344 protected:
 345         void region_resized (const PBD::PropertyChange&);
 346
 347         void set_flags (XMLNode *);
 348         void store_flags ();
 349
 350         void reset_width_dependent_items (double pixel_width);
 351
 352         void parameter_changed (std::string const & p);
 353
 354 private:
 355
 356         friend class MidiRubberbandSelectDrag;
 357         friend class MidiVerticalSelectDrag;
 358         friend class NoteCreateDrag;
 359         friend class HitCreateDrag;
 360
 361         friend class EditNoteDialog;
 362
 363         /** Play the NoteOn event of the given note immediately
 364          * and schedule the playback of the corresponding NoteOff event.
 365          */
 366         void play_midi_note (boost::shared_ptr<NoteType> note);
 367         void start_playing_midi_note (boost::shared_ptr<NoteType> note);
 368         void start_playing_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
 369
 370         /** Clear the note selection of just this midi region
 371          */
 372         void clear_selection_internal ();
 373
 374         void clear_editor_note_selection ();
 375
 376         void clear_events ();
 377
 378         bool canvas_group_event(GdkEvent* ev);
 379         bool note_canvas_event(GdkEvent* ev);
 380
 381         void midi_channel_mode_changed ();
 382         PBD::ScopedConnection _channel_mode_changed_connection;
 383         void instrument_settings_changed ();
 384         PBD::ScopedConnection _instrument_changed_connection;
 385
 386         void change_note_channel (NoteBase *, int8_t, bool relative=false);
 387         void change_note_velocity(NoteBase* ev, int8_t vel, bool relative=false);
 388         void change_note_note(NoteBase* ev, int8_t note, bool relative=false);
 389         void change_note_time(NoteBase* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
 390         void change_note_length (NoteBase *, ARDOUR::MidiModel::TimeType);
 391         void trim_note(NoteBase* ev, ARDOUR::MidiModel::TimeType start_delta,
 392                        ARDOUR::MidiModel::TimeType end_delta);
 393
 394         void update_drag_selection (framepos_t start, framepos_t end, double y0, double y1, bool extend);
 395         void update_vertical_drag_selection (double last_y, double y, bool extend);
 396
 397         void add_to_selection (NoteBase*);
 398         void remove_from_selection (NoteBase*);
 399
 400         std::string get_note_name (boost::shared_ptr<NoteType> note, uint8_t note_value) const;
 401
 402         void show_verbose_cursor (std::string const &, double, double) const;
 403         void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
 404
 405         uint8_t get_velocity_for_add (ARDOUR::MidiModel::TimeType time) const;
 406
 407         uint8_t  _current_range_min;
 408         uint8_t  _current_range_max;
 409
 410         typedef std::list<NoteBase*>                          Events;
 411         typedef std::vector< boost::shared_ptr<PatchChange> > PatchChanges;
 412         typedef std::vector< boost::shared_ptr<SysEx> >       SysExes;
 413
 414         ARDOUR::BeatsFramesConverter _region_relative_time_converter;
 415         ARDOUR::BeatsFramesConverter _source_relative_time_converter;
 416         ARDOUR::DoubleBeatsFramesConverter _region_relative_time_converter_double;
 417
 418         boost::shared_ptr<ARDOUR::MidiModel> _model;
 419         Events                               _events;
 420         PatchChanges                         _patch_changes;
 421         SysExes                              _sys_exes;
 422         Note**                               _active_notes;
 423         ArdourCanvas::Container*             _note_group;
 424         ARDOUR::MidiModel::NoteDiffCommand*  _note_diff_command;
 425         NoteBase*                            _ghost_note;
 426         double                               _last_ghost_x;
 427         double                               _last_ghost_y;
 428         ArdourCanvas::Rectangle*             _step_edit_cursor;
 429         Evoral::Beats                        _step_edit_cursor_width;
 430         Evoral::Beats                        _step_edit_cursor_position;
 431         NoteBase*                            _channel_selection_scoped_note;
 432
 433         MouseState _mouse_state;
 434         int _pressed_button;
 435
 436         /** Currently selected NoteBase objects */
 437         Selection _selection;
 438
 439         bool _sort_needed;
 440         void time_sort_events ();
 441
 442         MidiCutBuffer* selection_as_cut_buffer () const;
 443
 444         /** New notes (created in the current command) which should be selected
 445          * when they appear after the command is applied. */
 446         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 447
 448         /** Notes that should be selected when the model is redisplayed. */
 449         std::set<Evoral::event_id_t> _pending_note_selection;
 450
 451         /** New notes (created in the current command) which should have visible velocity
 452          * when they appear after the command is applied. */
 453         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 454
 455         std::vector<NoteResizeData *> _resize_data;
 456
 457         /** connection used to connect to model's ContentChanged signal */
 458         PBD::ScopedConnection content_connection;
 459
 460         NoteBase* find_canvas_note (boost::shared_ptr<NoteType>);
 461         NoteBase* find_canvas_note (Evoral::event_id_t id);
 462         Events::iterator _optimization_iterator;
 463
 464         void update_note (NoteBase*, bool update_ghost_regions = true);
 465         void update_sustained (Note *, bool update_ghost_regions = true);
 466         void update_hit (Hit *, bool update_ghost_regions = true);
 467
 468         void create_ghost_note (double, double, uint32_t state);
 469         void update_ghost_note (double, double, uint32_t state);
 470
 471         MidiListEditor* _list_editor;
 472         bool _no_sound_notes;
 473
 474         void snap_changed ();
 475         PBD::ScopedConnection snap_changed_connection;
 476
 477         bool motion (GdkEventMotion*);
 478         bool scroll (GdkEventScroll*);
 479         bool key_press (GdkEventKey*);
 480         bool key_release (GdkEventKey*);
 481         bool button_press (GdkEventButton*);
 482         bool button_release (GdkEventButton*);
 483         bool enter_notify (GdkEventCrossing*);
 484         bool leave_notify (GdkEventCrossing*);
 485
 486         void drop_down_keys ();
 487         void maybe_select_by_position (GdkEventButton* ev, double x, double y);
 488         void get_events (Events& e, Evoral::Sequence<Evoral::Beats>::NoteOperator op, uint8_t val, int chan_mask = 0);
 489
 490         void display_patch_changes_on_channel (uint8_t, bool);
 491
 492         void connect_to_diskstream ();
 493         void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
 494
 495         /** Get grid type as beats, or default to 1 if not snapped to beats. */
 496         Evoral::Beats get_grid_beats(framepos_t pos) const;
 497
 498         void remove_ghost_note ();
 499         void mouse_mode_changed ();
 500         void enter_internal (uint32_t state);
 501         void leave_internal ();
 502         void hide_verbose_cursor ();
 503
 504         framecnt_t _last_display_zoom;
 505
 506         double    _last_event_x;
 507         double    _last_event_y;
 508         bool      _grabbed_keyboard;
 509         bool      _entered;
 510         NoteBase* _entered_note;
 511
 512         bool _mouse_changed_selection;
 513
 514         Evoral::Beats snap_frame_to_grid_underneath (framepos_t p, int32_t divisions, bool shift_snap) const;
 515
 516         PBD::ScopedConnection _mouse_mode_connection;
 517
 518         boost::shared_ptr<CursorContext> _press_cursor_ctx;
 519
 520         ARDOUR::ChannelMode get_channel_mode() const;
 521         uint16_t get_selected_channels () const;
 522 };
 523
 524
 525 #endif /* __gtk_ardour_midi_region_view_h__ */