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
  25 #include <libgnomecanvasmm.h>
  26 #include <libgnomecanvasmm/polygon.h>
  27
  28 #include "pbd/signals.h"
  29
  30 #include "ardour/midi_track.h"
  31 #include "ardour/midi_model.h"
  32 #include "ardour/diskstream.h"
  33 #include "ardour/types.h"
  34
  35 #include "editing.h"
  36 #include "region_view.h"
  37 #include "midi_time_axis.h"
  38 #include "time_axis_view_item.h"
  39 #include "automation_line.h"
  40 #include "enums.h"
  41 #include "canvas.h"
  42 #include "canvas-hit.h"
  43 #include "canvas-note.h"
  44 #include "canvas-note-event.h"
  45 #include "canvas_patch_change.h"
  46 #include "canvas-sysex.h"
  47
  48 namespace ARDOUR {
  49         class MidiRegion;
  50         class MidiModel;
  51         class Filter;
  52 };
  53
  54 namespace MIDI {
  55         namespace Name {
  56                 struct PatchPrimaryKey;
  57         };
  58 };
  59
  60 class MidiTimeAxisView;
  61 class GhostRegion;
  62 class AutomationTimeAxisView;
  63 class AutomationRegionView;
  64 class MidiCutBuffer;
  65 class MidiListEditor;
  66 class EditNoteDialog;
  67 class NotePlayer;
  68
  69 class MidiRegionView : public RegionView
  70 {
  71 public:
  72         typedef Evoral::Note<Evoral::MusicalTime> NoteType;
  73         typedef Evoral::Sequence<Evoral::MusicalTime>::Notes Notes;
  74
  75         MidiRegionView (ArdourCanvas::Group *,
  76                         RouteTimeAxisView&,
  77                         boost::shared_ptr<ARDOUR::MidiRegion>,
  78                         double initial_samples_per_unit,
  79                         Gdk::Color const & basic_color);
  80
  81         MidiRegionView (const MidiRegionView& other);
  82         MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
  83
  84         ~MidiRegionView ();
  85
  86         virtual void init (Gdk::Color const & basic_color, bool wfd);
  87
  88         const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const;
  89
  90         inline MidiTimeAxisView* midi_view() const
  91         { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
  92
  93         inline MidiStreamView* midi_stream_view() const
  94         { return midi_view()->midi_view(); }
  95
  96         void step_add_note (uint8_t channel, uint8_t number, uint8_t velocity,
  97                             Evoral::MusicalTime pos, Evoral::MusicalTime len);
  98         void step_sustain (Evoral::MusicalTime beats);
  99         void set_height (double);
 100         void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
 101
 102         inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
 103
 104         void set_frame_color();
 105         void color_handler ();
 106
 107         void show_step_edit_cursor (Evoral::MusicalTime pos);
 108         void move_step_edit_cursor (Evoral::MusicalTime pos);
 109         void hide_step_edit_cursor ();
 110         void set_step_edit_cursor_width (Evoral::MusicalTime beats);
 111
 112         void redisplay_model();
 113
 114         GhostRegion* add_ghost (TimeAxisView&);
 115
 116         void add_note(const boost::shared_ptr<NoteType> note, bool visible);
 117         void resolve_note(uint8_t note_num, double end_time);
 118
 119         void cut_copy_clear (Editing::CutCopyOp);
 120         void paste (framepos_t pos, float times, const MidiCutBuffer&);
 121
 122         void add_canvas_patch_change (ARDOUR::MidiModel::PatchChangePtr patch, const std::string& displaytext, bool);
 123
 124         /** Look up the given time and channel in the 'automation' and set keys accordingly.
 125          * @param time the time of the patch change event
 126          * @param channel the MIDI channel of the event
 127          * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
 128          *        will be set according to the result of the lookup
 129          */
 130         void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
 131
 132         /** Change old_patch to new_patch.
 133          * @param old_patch the canvas patch change which is to be altered
 134          * @param new_patch new patch
 135          */
 136         void change_patch_change (ArdourCanvas::CanvasPatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
 137         void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::MusicalTime> const &);
 138
 139         void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::MusicalTime> const &);
 140         void move_patch_change (ArdourCanvas::CanvasPatchChange &, Evoral::MusicalTime);
 141         void delete_patch_change (ArdourCanvas::CanvasPatchChange *);
 142         void edit_patch_change (ArdourCanvas::CanvasPatchChange *);
 143
 144         /** Alter a given patch to be its predecessor in the MIDNAM file.
 145          */
 146         void previous_patch (ArdourCanvas::CanvasPatchChange &);
 147
 148         /** Alters a given patch to be its successor in the MIDNAM file.
 149          */
 150         void next_patch (ArdourCanvas::CanvasPatchChange &);
 151
 152         void previous_bank (ArdourCanvas::CanvasPatchChange &);
 153         void next_bank (ArdourCanvas::CanvasPatchChange &);
 154
 155         /** Displays all patch change events in the region as flags on the canvas.
 156          */
 157         void display_patch_changes();
 158
 159         /** Displays all system exclusive events in the region as flags on the canvas.
 160          */
 161         void display_sysexes();
 162
 163         void begin_write();
 164         void end_write();
 165         void extend_active_notes();
 166
 167         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
 168
 169         void start_note_diff_command (std::string name = "midi edit");
 170         void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
 171         void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
 172         void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
 173         void note_diff_remove_note (ArdourCanvas::CanvasNoteEvent* ev);
 174
 175         void apply_diff (bool as_subcommand = false);
 176         void abort_command();
 177
 178         void   note_entered(ArdourCanvas::CanvasNoteEvent* ev);
 179         void   note_left(ArdourCanvas::CanvasNoteEvent* ev);
 180         void   patch_entered (ArdourCanvas::CanvasPatchChange *);
 181         void   patch_left (ArdourCanvas::CanvasPatchChange *);
 182         void   note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
 183         void   unique_select(ArdourCanvas::CanvasNoteEvent* ev);
 184         void   note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add, bool extend=false);
 185         void   note_deselected(ArdourCanvas::CanvasNoteEvent* ev);
 186         void   delete_selection();
 187         void   delete_note (boost::shared_ptr<NoteType>);
 188         size_t selection_size() { return _selection.size(); }
 189         void   select_all_notes ();
 190         void   select_range(framepos_t start, framepos_t end);
 191         void   invert_selection ();
 192
 193         void move_selection(double dx, double dy, double cumulative_dy);
 194         void note_dropped (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::frameoffset_t, int8_t d_note);
 195
 196         void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
 197         void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
 198
 199         /** Return true iff the note is within the extent of the region.
 200          * @param visible will be set to true if the note is within the visible note range, false otherwise.
 201          */
 202         bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
 203
 204         /** Get the region position in pixels relative to session. */
 205         double get_position_pixels();
 206
 207         /** Get the region end position in pixels relative to session. */
 208         double get_end_position_pixels();
 209
 210         /** Begin resizing of some notes.
 211          * Called by CanvasMidiNote when resizing starts.
 212          * @param at_front which end of the note (true == note on, false == note off)
 213          */
 214         void begin_resizing(bool at_front);
 215
 216         void update_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
 217         void commit_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
 218         void abort_resizing ();
 219
 220         /** Change the channel of the selection.
 221          * @param channel - the channel number of the new channel, zero-based
 222          */
 223         void change_channel(uint8_t channel);
 224
 225         enum MouseState {
 226                 None,
 227                 Pressed,
 228                 SelectTouchDragging,
 229                 SelectRectDragging,
 230                 SelectVerticalDragging,
 231                 AddDragging
 232         };
 233
 234         MouseState mouse_state() const { return _mouse_state; }
 235
 236         void note_button_release ();
 237
 238         struct NoteResizeData {
 239                 ArdourCanvas::CanvasNote  *canvas_note;
 240                 ArdourCanvas::SimpleRect  *resize_rect;
 241         };
 242
 243         /** Snap a region relative pixel coordinate to pixel units.
 244          * @param x a pixel coordinate relative to region start
 245          * @return the snapped pixel coordinate relative to region start
 246          */
 247         double snap_to_pixel(double x);
 248
 249         /** Snap a region relative pixel coordinate to frame units.
 250          * @param x a pixel coordinate relative to region start
 251          * @return the snapped framepos_t coordinate relative to region start
 252          */
 253         framepos_t snap_pixel_to_frame(double x);
 254
 255         /** Convert a timestamp in beats into frames (both relative to region position) */
 256         framepos_t region_beats_to_region_frames(double beats) const;
 257         /** Convert a timestamp in beats into absolute frames */
 258         framepos_t region_beats_to_absolute_frames(double beats) const {
 259                 return _region->position() + region_beats_to_region_frames (beats);
 260         }
 261         /** Convert a timestamp in frames to beats (both relative to region position) */
 262         double region_frames_to_region_beats(framepos_t) const;
 263
 264         /** Convert a timestamp in beats measured from source start into absolute frames */
 265         framepos_t source_beats_to_absolute_frames(double beats) const;
 266         /** Convert a timestamp in beats measured from source start into region-relative frames */
 267         framepos_t source_beats_to_region_frames(double beats) const {
 268                 return source_beats_to_absolute_frames (beats) - _region->position();
 269         }
 270         /** Convert a timestamp in absolute frames to beats measured from source start*/
 271         double absolute_frames_to_source_beats(framepos_t) const;
 272
 273         void goto_previous_note (bool add_to_selection);
 274         void goto_next_note (bool add_to_selection);
 275         void change_note_lengths (bool, bool, Evoral::MusicalTime beats, bool start, bool end);
 276         void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
 277         void transpose (bool up, bool fine, bool allow_smush);
 278         void nudge_notes (bool forward);
 279         void channel_edit ();
 280         void velocity_edit ();
 281
 282         void show_list_editor ();
 283
 284         typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
 285         Selection selection () const {
 286                 return _selection;
 287         }
 288
 289         void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
 290
 291         void enable_display (bool);
 292
 293         void set_channel_selector_scoped_note(ArdourCanvas::CanvasNoteEvent* note){ _channel_selection_scoped_note = note; }
 294         ArdourCanvas::CanvasNoteEvent* channel_selector_scoped_note(){  return _channel_selection_scoped_note; }
 295
 296         void trim_front_starting ();
 297         void trim_front_ending ();
 298
 299         void create_note_at (framepos_t, double, double, bool);
 300
 301         void clear_selection (bool signal = true) { clear_selection_except (0, signal); }
 302
 303         std::string model_name () const {
 304                 return _model_name;
 305         }
 306
 307         std::string custom_device_mode () const {
 308                 return _custom_device_mode;
 309         }
 310
 311 protected:
 312         /** Allows derived types to specify their visibility requirements
 313          * to the TimeAxisViewItem parent class.
 314          */
 315         MidiRegionView (ArdourCanvas::Group *,
 316                         RouteTimeAxisView&,
 317                         boost::shared_ptr<ARDOUR::MidiRegion>,
 318                         double samples_per_unit,
 319                         Gdk::Color& basic_color,
 320                         TimeAxisViewItem::Visibility);
 321
 322         void region_resized (const PBD::PropertyChange&);
 323
 324         void set_flags (XMLNode *);
 325         void store_flags ();
 326
 327         void reset_width_dependent_items (double pixel_width);
 328
 329         void parameter_changed (std::string const & p);
 330
 331 private:
 332
 333         friend class MidiRubberbandSelectDrag;
 334         friend class MidiVerticalSelectDrag;
 335
 336         /** Emitted when the selection has been cleared in one MidiRegionView,
 337          *  with the expectation that others will clear their selections in
 338          *  sympathy.
 339          */
 340         static PBD::Signal1<void, MidiRegionView*> SelectionCleared;
 341         PBD::ScopedConnection _selection_cleared_connection;
 342         void selection_cleared (MidiRegionView *);
 343
 344         friend class EditNoteDialog;
 345
 346         /** Play the NoteOn event of the given note immediately
 347          * and schedule the playback of the corresponding NoteOff event.
 348          */
 349         void play_midi_note (boost::shared_ptr<NoteType> note);
 350         void start_playing_midi_note (boost::shared_ptr<NoteType> note);
 351         void start_playing_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
 352
 353         void clear_events();
 354
 355         bool canvas_event(GdkEvent* ev);
 356         bool note_canvas_event(GdkEvent* ev);
 357
 358         void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
 359         void instrument_settings_changed ();
 360         PBD::ScopedConnection _instrument_changed_connection;
 361
 362         void change_note_channel (ArdourCanvas::CanvasNoteEvent *, int8_t, bool relative=false);
 363         void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
 364         void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
 365         void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
 366         void change_note_length (ArdourCanvas::CanvasNoteEvent *, ARDOUR::MidiModel::TimeType);
 367         void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
 368                        ARDOUR::MidiModel::TimeType end_delta);
 369
 370         void clear_selection_except (ArdourCanvas::CanvasNoteEvent* ev, bool signal = true);
 371         void update_drag_selection (double last_x, double x, double last_y, double y, bool extend);
 372         void update_vertical_drag_selection (double last_y, double y, bool extend);
 373
 374         void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
 375         void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
 376
 377         void show_verbose_cursor (std::string const &, double, double) const;
 378         void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
 379
 380         uint16_t _last_channel_selection;
 381         uint8_t  _current_range_min;
 382         uint8_t  _current_range_max;
 383
 384         /// MIDNAM information of the current track: Model name of MIDNAM file
 385         std::string _model_name;
 386
 387         /// MIDNAM information of the current track: CustomDeviceMode
 388         std::string _custom_device_mode;
 389
 390         typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
 391         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasPatchChange> > PatchChanges;
 392         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
 393
 394         boost::shared_ptr<ARDOUR::MidiModel> _model;
 395         Events                               _events;
 396         PatchChanges                         _patch_changes;
 397         SysExes                              _sys_exes;
 398         ArdourCanvas::CanvasNote**           _active_notes;
 399         ArdourCanvas::Group*                 _note_group;
 400         ARDOUR::MidiModel::NoteDiffCommand*  _note_diff_command;
 401         ArdourCanvas::CanvasNote*            _ghost_note;
 402         double                               _last_ghost_x;
 403         double                               _last_ghost_y;
 404         ArdourCanvas::SimpleRect*            _step_edit_cursor;
 405         Evoral::MusicalTime                  _step_edit_cursor_width;
 406         Evoral::MusicalTime                  _step_edit_cursor_position;
 407         ArdourCanvas::CanvasNoteEvent*       _channel_selection_scoped_note;
 408
 409
 410         /** A group used to temporarily reparent _note_group to during start trims, so
 411          *  that the notes don't move with the parent region view.
 412          */
 413         ArdourCanvas::Group*                 _temporary_note_group;
 414
 415         MouseState _mouse_state;
 416         int _pressed_button;
 417
 418         /** Currently selected CanvasNoteEvents */
 419         Selection _selection;
 420
 421         bool _sort_needed;
 422         void time_sort_events ();
 423
 424         MidiCutBuffer* selection_as_cut_buffer () const;
 425
 426         /** New notes (created in the current command) which should be selected
 427          * when they appear after the command is applied. */
 428         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 429
 430         /** New notes (created in the current command) which should have visible velocity
 431          * when they appear after the command is applied. */
 432         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 433
 434         std::vector<NoteResizeData *> _resize_data;
 435
 436         /** connection used to connect to model's ContentChanged signal */
 437         PBD::ScopedConnection content_connection;
 438
 439         ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
 440         Events::iterator _optimization_iterator;
 441
 442         void update_note (ArdourCanvas::CanvasNote *, bool update_ghost_regions = true);
 443         double update_hit (ArdourCanvas::CanvasHit *);
 444         void create_ghost_note (double, double);
 445         void update_ghost_note (double, double);
 446
 447         MidiListEditor* _list_editor;
 448         bool _no_sound_notes;
 449
 450         PBD::ScopedConnection note_delete_connection;
 451         void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
 452
 453         void snap_changed ();
 454         PBD::ScopedConnection snap_changed_connection;
 455
 456         bool motion (GdkEventMotion*);
 457         bool scroll (GdkEventScroll*);
 458         bool key_press (GdkEventKey*);
 459         bool key_release (GdkEventKey*);
 460         bool button_press (GdkEventButton*);
 461         bool button_release (GdkEventButton*);
 462         bool enter_notify (GdkEventCrossing*);
 463         bool leave_notify (GdkEventCrossing*);
 464
 465         void drop_down_keys ();
 466         void maybe_select_by_position (GdkEventButton* ev, double x, double y);
 467         void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
 468
 469         void display_patch_changes_on_channel (uint8_t, bool);
 470
 471         void connect_to_diskstream ();
 472         void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
 473
 474         void remove_ghost_note ();
 475         void mouse_mode_changed ();
 476         double _last_event_x;
 477         double _last_event_y;
 478
 479         framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
 480
 481         PBD::ScopedConnection _mouse_mode_connection;
 482
 483         Gdk::Cursor* pre_enter_cursor;
 484         Gdk::Cursor* pre_press_cursor;
 485
 486         NotePlayer* _note_player;
 487 };
 488
 489
 490 #endif /* __gtk_ardour_midi_region_view_h__ */