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
  65 class MidiRegionView : public RegionView
  66 {
  67 public:
  68         typedef Evoral::Note<Evoral::MusicalTime> NoteType;
  69         typedef Evoral::Sequence<Evoral::MusicalTime>::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::MusicalTime pos, Evoral::MusicalTime len);
 103         void step_sustain (Evoral::MusicalTime 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         void set_frame_color();
 110         void color_handler ();
 111
 112         uint32_t fill_opacity() const;
 113
 114         void show_step_edit_cursor (Evoral::MusicalTime pos);
 115         void move_step_edit_cursor (Evoral::MusicalTime pos);
 116         void hide_step_edit_cursor ();
 117         void set_step_edit_cursor_width (Evoral::MusicalTime beats);
 118
 119         void redisplay_model();
 120
 121         GhostRegion* add_ghost (TimeAxisView&);
 122
 123         void add_note(const boost::shared_ptr<NoteType> note, bool visible);
 124         void resolve_note(uint8_t note_num, Evoral::MusicalTime end_time);
 125
 126         void cut_copy_clear (Editing::CutCopyOp);
 127         bool paste (framepos_t pos, const ::Selection& selection, PasteContext& ctx);
 128         void paste_internal (framepos_t pos, unsigned paste_count, float times, const MidiCutBuffer&);
 129
 130         void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext, bool);
 131
 132         /** Look up the given time and channel in the 'automation' and set keys accordingly.
 133          * @param time the time of the patch change event
 134          * @param channel the MIDI channel of the event
 135          * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
 136          *        will be set according to the result of the lookup
 137          */
 138         void get_patch_key_at (Evoral::MusicalTime time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key) const;
 139
 140         /** Convert a given PatchChange into a PatchPrimaryKey
 141          */
 142         MIDI::Name::PatchPrimaryKey patch_change_to_patch_key (ARDOUR::MidiModel::PatchChangePtr);
 143
 144         /** Change old_patch to new_patch.
 145          * @param old_patch the canvas patch change which is to be altered
 146          * @param new_patch new patch
 147          */
 148         void change_patch_change (PatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
 149         void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::MusicalTime> const &);
 150
 151         void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::MusicalTime> const &);
 152         void move_patch_change (PatchChange &, Evoral::MusicalTime);
 153         void delete_patch_change (PatchChange *);
 154         void edit_patch_change (PatchChange *);
 155
 156         void delete_sysex (SysEx*);
 157
 158         /** Change a patch to the next or previous bank/program.
 159          * @param bank If true, step bank, otherwise, step program.
 160          * @param delta Amount to adjust number.
 161          */
 162         void step_patch (PatchChange& patch, bool bank, int delta);
 163
 164         /** Displays all patch change events in the region as flags on the canvas.
 165          */
 166         void display_patch_changes();
 167
 168         /** Displays all system exclusive events in the region as flags on the canvas.
 169          */
 170         void display_sysexes();
 171
 172         void begin_write();
 173         void end_write();
 174         void extend_active_notes();
 175
 176         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
 177
 178         void start_note_diff_command (std::string name = "midi edit");
 179         void note_diff_add_change (NoteBase* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
 180         void note_diff_add_change (NoteBase* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
 181         void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
 182         void note_diff_remove_note (NoteBase* ev);
 183
 184         void apply_diff (bool as_subcommand = false);
 185         void abort_command();
 186
 187         void   note_entered(NoteBase* ev);
 188         void   note_left(NoteBase* ev);
 189         void   patch_entered (PatchChange *);
 190         void   patch_left (PatchChange *);
 191         void   sysex_entered (SysEx* p);
 192         void   sysex_left (SysEx* p);
 193         void   note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
 194         void   unique_select(NoteBase* ev);
 195         void   note_selected(NoteBase* ev, bool add, bool extend=false);
 196         void   note_deselected(NoteBase* ev);
 197         void   delete_selection();
 198         void   delete_note (boost::shared_ptr<NoteType>);
 199         size_t selection_size() { return _selection.size(); }
 200         void   select_all_notes ();
 201         void   select_range(framepos_t start, framepos_t end);
 202         void   invert_selection ();
 203
 204         void move_selection(double dx, double dy, double cumulative_dy);
 205         void note_dropped (NoteBase* ev, ARDOUR::frameoffset_t, int8_t d_note);
 206
 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::MusicalTime beats) const;
 268         /** Convert a timestamp in beats into absolute frames */
 269         framepos_t region_beats_to_absolute_frames(Evoral::MusicalTime 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::MusicalTime 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::MusicalTime 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::MusicalTime 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::MusicalTime 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::MusicalTime 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::MusicalTime 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  _current_range_min;
 396         uint8_t  _current_range_max;
 397
 398         typedef std::list<NoteBase*>                          Events;
 399         typedef std::vector< boost::shared_ptr<PatchChange> > PatchChanges;
 400         typedef std::vector< boost::shared_ptr<SysEx> >       SysExes;
 401
 402         ARDOUR::BeatsFramesConverter _region_relative_time_converter;
 403         ARDOUR::BeatsFramesConverter _source_relative_time_converter;
 404
 405         boost::shared_ptr<ARDOUR::MidiModel> _model;
 406         Events                               _events;
 407         PatchChanges                         _patch_changes;
 408         SysExes                              _sys_exes;
 409         Note**                               _active_notes;
 410         ArdourCanvas::Container*             _note_group;
 411         ARDOUR::MidiModel::NoteDiffCommand*  _note_diff_command;
 412         Note*                                _ghost_note;
 413         double                               _last_ghost_x;
 414         double                               _last_ghost_y;
 415         ArdourCanvas::Rectangle*             _step_edit_cursor;
 416         Evoral::MusicalTime                  _step_edit_cursor_width;
 417         Evoral::MusicalTime                  _step_edit_cursor_position;
 418         NoteBase*                            _channel_selection_scoped_note;
 419
 420         /** A group used to temporarily reparent _note_group to during start trims, so
 421          *  that the notes don't move with the parent region view.
 422          */
 423         ArdourCanvas::Container*                 _temporary_note_group;
 424
 425         MouseState _mouse_state;
 426         int _pressed_button;
 427
 428         /** Currently selected NoteBase objects */
 429         Selection _selection;
 430
 431         bool _sort_needed;
 432         void time_sort_events ();
 433
 434         MidiCutBuffer* selection_as_cut_buffer () const;
 435
 436         /** New notes (created in the current command) which should be selected
 437          * when they appear after the command is applied. */
 438         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 439
 440         /** New notes (created in the current command) which should have visible velocity
 441          * when they appear after the command is applied. */
 442         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 443
 444         std::vector<NoteResizeData *> _resize_data;
 445
 446         /** connection used to connect to model's ContentChanged signal */
 447         PBD::ScopedConnection content_connection;
 448
 449         NoteBase* find_canvas_note (boost::shared_ptr<NoteType>);
 450         Events::iterator _optimization_iterator;
 451
 452         void update_note (Note *, bool update_ghost_regions = true);
 453         void update_hit (Hit *);
 454         void create_ghost_note (double, double);
 455         void update_ghost_note (double, double);
 456
 457         MidiListEditor* _list_editor;
 458         bool _no_sound_notes;
 459
 460         PBD::ScopedConnection note_delete_connection;
 461         void maybe_remove_deleted_note_from_selection (NoteBase*);
 462
 463         void snap_changed ();
 464         PBD::ScopedConnection snap_changed_connection;
 465
 466         bool motion (GdkEventMotion*);
 467         bool scroll (GdkEventScroll*);
 468         bool key_press (GdkEventKey*);
 469         bool key_release (GdkEventKey*);
 470         bool button_press (GdkEventButton*);
 471         bool button_release (GdkEventButton*);
 472         bool enter_notify (GdkEventCrossing*);
 473         bool leave_notify (GdkEventCrossing*);
 474
 475         void drop_down_keys ();
 476         void maybe_select_by_position (GdkEventButton* ev, double x, double y);
 477         void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
 478
 479         void display_patch_changes_on_channel (uint8_t, bool);
 480
 481         void connect_to_diskstream ();
 482         void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
 483
 484         /** Get grid type as beats, or default to 1 if not snapped to beats. */
 485         Evoral::MusicalTime get_grid_beats(framepos_t pos) const;
 486
 487         void remove_ghost_note ();
 488         void mouse_mode_changed ();
 489         void enter_internal ();
 490         void leave_internal ();
 491
 492         double _last_event_x;
 493         double _last_event_y;
 494         bool   _grabbed_keyboard;
 495         bool   _entered;
 496
 497         framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
 498
 499         PBD::ScopedConnection _mouse_mode_connection;
 500
 501         Gdk::Cursor* pre_enter_cursor;
 502         Gdk::Cursor* pre_press_cursor;
 503         Gdk::Cursor* pre_note_enter_cursor;
 504
 505         NotePlayer* _note_player;
 506
 507         ARDOUR::ChannelMode get_channel_mode() const;
 508         uint16_t get_selected_channels () const;
 509 };
 510
 511
 512 #endif /* __gtk_ardour_midi_region_view_h__ */