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 NotePlayer;
  62 class PatchChange;
  63 class ItemCounts;
  64 class CursorContext;
  65
  66 class MidiRegionView : public RegionView
  67 {
  68 public:
  69         typedef Evoral::Note<Evoral::Beats> NoteType;
  70         typedef Evoral::Sequence<Evoral::Beats>::Notes Notes;
  71
  72         MidiRegionView (ArdourCanvas::Container*              parent,
  73                         RouteTimeAxisView&                    tv,
  74                         boost::shared_ptr<ARDOUR::MidiRegion> r,
  75                         double                                samples_per_pixel,
  76                         uint32_t                              basic_color);
  77
  78         MidiRegionView (ArdourCanvas::Container*              parent,
  79                         RouteTimeAxisView&                    tv,
  80                         boost::shared_ptr<ARDOUR::MidiRegion> r,
  81                         double                                samples_per_pixel,
  82                         uint32_t                              basic_color,
  83                         bool                                  recording,
  84                         Visibility                            visibility);
  85
  86
  87         MidiRegionView (const MidiRegionView& other);
  88         MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
  89
  90         ~MidiRegionView ();
  91
  92         void init (bool wfd);
  93
  94         const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const;
  95
  96         inline MidiTimeAxisView* midi_view() const
  97         { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
  98
  99         inline MidiStreamView* midi_stream_view() const
 100         { return midi_view()->midi_view(); }
 101
 102         void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
 103                             Evoral::Beats pos, Evoral::Beats len);
 104         void step_sustain (Evoral::Beats beats);
 105         void set_height (double);
 106         void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
 107
 108         inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
 109
 110         uint32_t get_fill_color() const;
 111         void color_handler ();
 112
 113         void show_step_edit_cursor (Evoral::Beats pos);
 114         void move_step_edit_cursor (Evoral::Beats pos);
 115         void hide_step_edit_cursor ();
 116         void set_step_edit_cursor_width (Evoral::Beats beats);
 117
 118         void redisplay_model();
 119
 120         GhostRegion* add_ghost (TimeAxisView&);
 121
 122         void add_note(const boost::shared_ptr<NoteType> note, bool visible);
 123         void resolve_note(uint8_t note_num, Evoral::Beats end_time);
 124
 125         void cut_copy_clear (Editing::CutCopyOp);
 126         bool paste (framepos_t pos, const ::Selection& selection, PasteContext& ctx);
 127         void paste_internal (framepos_t pos, unsigned paste_count, float times, const MidiCutBuffer&);
 128
 129         void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext, bool);
 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 (Evoral::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<Evoral::Beats> const &);
 149
 150         void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::Beats> const &);
 151         void move_patch_change (PatchChange &, Evoral::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, Evoral::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);
 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(framepos_t start, framepos_t end);
 201         void   invert_selection ();
 202
 203         void move_selection(double dx, double dy, double cumulative_dy);
 204         void note_dropped (NoteBase* ev, ARDOUR::frameoffset_t, int8_t d_note);
 205
 206         void select_notes (std::list<boost::shared_ptr<NoteType> >);
 207         void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
 208         void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
 209
 210         /** Return true iff the note is within the extent of the region.
 211          * @param visible will be set to true if the note is within the visible note range, false otherwise.
 212          */
 213         bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
 214
 215         /** Get the region position in pixels relative to session. */
 216         double get_position_pixels();
 217
 218         /** Get the region end position in pixels relative to session. */
 219         double get_end_position_pixels();
 220
 221         /** Begin resizing of some notes.
 222          * Called by CanvasMidiNote when resizing starts.
 223          * @param at_front which end of the note (true == note on, false == note off)
 224          */
 225         void begin_resizing(bool at_front);
 226
 227         void update_resizing (NoteBase*, bool, double, bool);
 228         void commit_resizing (NoteBase*, bool, double, bool);
 229         void abort_resizing ();
 230
 231         /** Change the channel of the selection.
 232          * @param channel - the channel number of the new channel, zero-based
 233          */
 234         void change_channel(uint8_t channel);
 235
 236         enum MouseState {
 237                 None,
 238                 Pressed,
 239                 SelectTouchDragging,
 240                 SelectRectDragging,
 241                 SelectVerticalDragging,
 242                 AddDragging
 243         };
 244
 245         MouseState mouse_state() const { return _mouse_state; }
 246
 247         void note_button_release ();
 248
 249         struct NoteResizeData {
 250                 Note                     *note;
 251                 ArdourCanvas::Rectangle  *resize_rect;
 252         };
 253
 254         /** Snap a region relative pixel coordinate to pixel units.
 255          * @param x a pixel coordinate relative to region start
 256          * @return the snapped pixel coordinate relative to region start
 257          */
 258         double snap_to_pixel(double x);
 259
 260         /** Snap a region relative pixel coordinate to frame units.
 261          * @param x a pixel coordinate relative to region start
 262          * @return the snapped framepos_t coordinate relative to region start
 263          */
 264         framepos_t snap_pixel_to_sample(double x);
 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
 275         /** Convert a timestamp in beats measured from source start into absolute frames */
 276         framepos_t source_beats_to_absolute_frames(Evoral::Beats beats) const;
 277         /** Convert a timestamp in beats measured from source start into region-relative frames */
 278         framepos_t source_beats_to_region_frames(Evoral::Beats beats) const {
 279                 return source_beats_to_absolute_frames (beats) - _region->position();
 280         }
 281         /** Convert a timestamp in absolute frames to beats measured from source start*/
 282         Evoral::Beats absolute_frames_to_source_beats(framepos_t) const;
 283
 284         ARDOUR::BeatsFramesConverter const & region_relative_time_converter () const {
 285                 return _region_relative_time_converter;
 286         }
 287
 288         ARDOUR::BeatsFramesConverter const & source_relative_time_converter () const {
 289                 return _source_relative_time_converter;
 290         }
 291
 292         void goto_previous_note (bool add_to_selection);
 293         void goto_next_note (bool add_to_selection);
 294         void change_note_lengths (bool, bool, Evoral::Beats beats, bool start, bool end);
 295         void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
 296         void transpose (bool up, bool fine, bool allow_smush);
 297         void nudge_notes (bool forward, bool fine);
 298         void channel_edit ();
 299         void velocity_edit ();
 300
 301         void show_list_editor ();
 302
 303         typedef std::set<NoteBase*> Selection;
 304         Selection selection () const {
 305                 return _selection;
 306         }
 307
 308         void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
 309
 310         void enable_display (bool);
 311
 312         void set_channel_selector_scoped_note(NoteBase* note){ _channel_selection_scoped_note = note; }
 313         NoteBase* channel_selector_scoped_note(){  return _channel_selection_scoped_note; }
 314
 315         void trim_front_starting ();
 316         void trim_front_ending ();
 317
 318         /** Add a note to the model, and the view, at a canvas (click) coordinate.
 319          * \param t time in frames relative to the position of the region
 320          * \param y vertical position in pixels
 321          * \param length duration of the note in beats
 322          * \param snap_t true to snap t to the grid, otherwise false.
 323          */
 324         void create_note_at (framepos_t t, double y, Evoral::Beats length, bool snap_t);
 325
 326         void clear_selection (bool signal = true) { clear_selection_except (0, signal); }
 327
 328         ARDOUR::InstrumentInfo& instrument_info() const;
 329
 330 protected:
 331         void region_resized (const PBD::PropertyChange&);
 332
 333         void set_flags (XMLNode *);
 334         void store_flags ();
 335
 336         void reset_width_dependent_items (double pixel_width);
 337
 338         void parameter_changed (std::string const & p);
 339
 340 private:
 341
 342         friend class MidiRubberbandSelectDrag;
 343         friend class MidiVerticalSelectDrag;
 344
 345         /** Emitted when the selection has been cleared in one MidiRegionView,
 346          *  with the expectation that others will clear their selections in
 347          *  sympathy.
 348          */
 349         static PBD::Signal1<void, MidiRegionView*> SelectionCleared;
 350         PBD::ScopedConnection _selection_cleared_connection;
 351         void selection_cleared (MidiRegionView *);
 352
 353         /** this handles the case when the "external" world wants us to clear our internal selections
 354          */
 355         PBD::ScopedConnection _clear_midi_selection_connection;
 356         void clear_midi_selection () { clear_selection(); }
 357
 358         friend class EditNoteDialog;
 359
 360         /** Play the NoteOn event of the given note immediately
 361          * and schedule the playback of the corresponding NoteOff event.
 362          */
 363         void play_midi_note (boost::shared_ptr<NoteType> note);
 364         void start_playing_midi_note (boost::shared_ptr<NoteType> note);
 365         void start_playing_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
 366
 367         void clear_events (bool with_selection_signal = true);
 368
 369         bool canvas_group_event(GdkEvent* ev);
 370         bool note_canvas_event(GdkEvent* ev);
 371
 372         void midi_channel_mode_changed ();
 373         PBD::ScopedConnection _channel_mode_changed_connection;
 374         void instrument_settings_changed ();
 375         PBD::ScopedConnection _instrument_changed_connection;
 376
 377         void change_note_channel (NoteBase *, int8_t, bool relative=false);
 378         void change_note_velocity(NoteBase* ev, int8_t vel, bool relative=false);
 379         void change_note_note(NoteBase* ev, int8_t note, bool relative=false);
 380         void change_note_time(NoteBase* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
 381         void change_note_length (NoteBase *, ARDOUR::MidiModel::TimeType);
 382         void trim_note(NoteBase* ev, ARDOUR::MidiModel::TimeType start_delta,
 383                        ARDOUR::MidiModel::TimeType end_delta);
 384
 385         void clear_selection_except (NoteBase* ev, bool signal = true);
 386         void update_drag_selection (framepos_t start, framepos_t end, double y0, double y1, bool extend);
 387         void update_vertical_drag_selection (double last_y, double y, bool extend);
 388
 389         void add_to_selection (NoteBase*);
 390         void remove_from_selection (NoteBase*);
 391
 392         void show_verbose_cursor (std::string const &, double, double) const;
 393         void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
 394
 395         uint8_t get_velocity_for_add (ARDOUR::MidiModel::TimeType time) const;
 396
 397         uint8_t  _current_range_min;
 398         uint8_t  _current_range_max;
 399
 400         typedef std::list<NoteBase*>                          Events;
 401         typedef std::vector< boost::shared_ptr<PatchChange> > PatchChanges;
 402         typedef std::vector< boost::shared_ptr<SysEx> >       SysExes;
 403
 404         ARDOUR::BeatsFramesConverter _region_relative_time_converter;
 405         ARDOUR::BeatsFramesConverter _source_relative_time_converter;
 406
 407         boost::shared_ptr<ARDOUR::MidiModel> _model;
 408         Events                               _events;
 409         PatchChanges                         _patch_changes;
 410         SysExes                              _sys_exes;
 411         Note**                               _active_notes;
 412         ArdourCanvas::Container*             _note_group;
 413         ARDOUR::MidiModel::NoteDiffCommand*  _note_diff_command;
 414         NoteBase*                            _ghost_note;
 415         double                               _last_ghost_x;
 416         double                               _last_ghost_y;
 417         ArdourCanvas::Rectangle*             _step_edit_cursor;
 418         Evoral::Beats                        _step_edit_cursor_width;
 419         Evoral::Beats                        _step_edit_cursor_position;
 420         NoteBase*                            _channel_selection_scoped_note;
 421
 422         /** A group used to temporarily reparent _note_group to during start trims, so
 423          *  that the notes don't move with the parent region view.
 424          */
 425         ArdourCanvas::Container*                 _temporary_note_group;
 426
 427         MouseState _mouse_state;
 428         int _pressed_button;
 429
 430         /** Currently selected NoteBase objects */
 431         Selection _selection;
 432
 433         bool _sort_needed;
 434         void time_sort_events ();
 435
 436         MidiCutBuffer* selection_as_cut_buffer () const;
 437
 438         /** New notes (created in the current command) which should be selected
 439          * when they appear after the command is applied. */
 440         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 441
 442         /** Notes that should be selected when the model is redisplayed. */
 443         std::set< boost::shared_ptr<NoteType> > _pending_note_selection;
 444
 445         /** New notes (created in the current command) which should have visible velocity
 446          * when they appear after the command is applied. */
 447         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 448
 449         std::vector<NoteResizeData *> _resize_data;
 450
 451         /** connection used to connect to model's ContentChanged signal */
 452         PBD::ScopedConnection content_connection;
 453
 454         NoteBase* find_canvas_note (boost::shared_ptr<NoteType>);
 455         NoteBase* find_canvas_note (NoteType);
 456         Events::iterator _optimization_iterator;
 457
 458         void update_note (NoteBase*, bool update_ghost_regions = true);
 459         void update_sustained (Note *, bool update_ghost_regions = true);
 460         void update_hit (Hit *, bool update_ghost_regions = true);
 461
 462         void create_ghost_note (double, double);
 463         void update_ghost_note (double, double);
 464
 465         MidiListEditor* _list_editor;
 466         bool _no_sound_notes;
 467
 468         PBD::ScopedConnection note_delete_connection;
 469         void maybe_remove_deleted_note_from_selection (NoteBase*);
 470
 471         void snap_changed ();
 472         PBD::ScopedConnection snap_changed_connection;
 473
 474         bool motion (GdkEventMotion*);
 475         bool scroll (GdkEventScroll*);
 476         bool key_press (GdkEventKey*);
 477         bool key_release (GdkEventKey*);
 478         bool button_press (GdkEventButton*);
 479         bool button_release (GdkEventButton*);
 480         bool enter_notify (GdkEventCrossing*);
 481         bool leave_notify (GdkEventCrossing*);
 482
 483         void drop_down_keys ();
 484         void maybe_select_by_position (GdkEventButton* ev, double x, double y);
 485         void get_events (Events& e, Evoral::Sequence<Evoral::Beats>::NoteOperator op, uint8_t val, int chan_mask = 0);
 486
 487         void display_patch_changes_on_channel (uint8_t, bool);
 488
 489         void connect_to_diskstream ();
 490         void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
 491
 492         /** Get grid type as beats, or default to 1 if not snapped to beats. */
 493         Evoral::Beats get_grid_beats(framepos_t pos) const;
 494
 495         void remove_ghost_note ();
 496         void mouse_mode_changed ();
 497         void enter_internal ();
 498         void leave_internal ();
 499
 500         framecnt_t _last_display_zoom;
 501
 502         double _last_event_x;
 503         double _last_event_y;
 504         bool   _grabbed_keyboard;
 505         bool   _entered;
 506
 507         bool _mouse_changed_selection;
 508
 509         framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
 510
 511         PBD::ScopedConnection _mouse_mode_connection;
 512
 513         boost::shared_ptr<CursorContext> _press_cursor_ctx;
 514
 515         boost::shared_ptr<NotePlayer> _note_player;
 516
 517         ARDOUR::ChannelMode get_channel_mode() const;
 518         uint16_t get_selected_channels () const;
 519 };
 520
 521
 522 #endif /* __gtk_ardour_midi_region_view_h__ */