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         /** Convert a given PatchChange into a PatchPrimaryKey
 133          */
 134         MIDI::Name::PatchPrimaryKey patch_change_to_patch_key (ARDOUR::MidiModel::PatchChangePtr);
 135
 136         /** Change old_patch to new_patch.
 137          * @param old_patch the canvas patch change which is to be altered
 138          * @param new_patch new patch
 139          */
 140         void change_patch_change (ArdourCanvas::CanvasPatchChange& old_patch, const MIDI::Name::PatchPrimaryKey& new_patch);
 141         void change_patch_change (ARDOUR::MidiModel::PatchChangePtr, Evoral::PatchChange<Evoral::MusicalTime> const &);
 142
 143         void add_patch_change (framecnt_t, Evoral::PatchChange<Evoral::MusicalTime> const &);
 144         void move_patch_change (ArdourCanvas::CanvasPatchChange &, Evoral::MusicalTime);
 145         void delete_patch_change (ArdourCanvas::CanvasPatchChange *);
 146         void edit_patch_change (ArdourCanvas::CanvasPatchChange *);
 147
 148         void delete_sysex (ArdourCanvas::CanvasSysEx*);
 149
 150         /** Alter a given patch to be its predecessor in the MIDNAM file.
 151          */
 152         void previous_patch (ArdourCanvas::CanvasPatchChange &);
 153
 154         /** Alters a given patch to be its successor in the MIDNAM file.
 155          */
 156         void next_patch (ArdourCanvas::CanvasPatchChange &);
 157
 158         void previous_bank (ArdourCanvas::CanvasPatchChange &);
 159         void next_bank (ArdourCanvas::CanvasPatchChange &);
 160
 161         /** Displays all patch change events in the region as flags on the canvas.
 162          */
 163         void display_patch_changes();
 164
 165         /** Displays all system exclusive events in the region as flags on the canvas.
 166          */
 167         void display_sysexes();
 168
 169         void begin_write();
 170         void end_write();
 171         void extend_active_notes();
 172
 173         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
 174
 175         void start_note_diff_command (std::string name = "midi edit");
 176         void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, uint8_t val);
 177         void note_diff_add_change (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::NoteDiffCommand::Property, Evoral::MusicalTime val);
 178         void note_diff_add_note (const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity = false);
 179         void note_diff_remove_note (ArdourCanvas::CanvasNoteEvent* ev);
 180
 181         void apply_diff (bool as_subcommand = false);
 182         void abort_command();
 183
 184         void   note_entered(ArdourCanvas::CanvasNoteEvent* ev);
 185         void   note_left(ArdourCanvas::CanvasNoteEvent* ev);
 186         void   patch_entered (ArdourCanvas::CanvasPatchChange *);
 187         void   patch_left (ArdourCanvas::CanvasPatchChange *);
 188         void   sysex_entered (ArdourCanvas::CanvasSysEx* p);
 189         void   sysex_left (ArdourCanvas::CanvasSysEx* p);
 190         void   note_mouse_position (float xfraction, float yfraction, bool can_set_cursor=true);
 191         void   unique_select(ArdourCanvas::CanvasNoteEvent* ev);
 192         void   note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add, bool extend=false);
 193         void   note_deselected(ArdourCanvas::CanvasNoteEvent* ev);
 194         void   delete_selection();
 195         void   delete_note (boost::shared_ptr<NoteType>);
 196         size_t selection_size() { return _selection.size(); }
 197         void   select_all_notes ();
 198         void   select_range(framepos_t start, framepos_t end);
 199         void   invert_selection ();
 200
 201         void move_selection(double dx, double dy, double cumulative_dy);
 202         void note_dropped (ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::frameoffset_t, int8_t d_note);
 203
 204         void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
 205         void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
 206
 207         /** Return true iff the note is within the extent of the region.
 208          * @param visible will be set to true if the note is within the visible note range, false otherwise.
 209          */
 210         bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
 211
 212         /** Get the region position in pixels relative to session. */
 213         double get_position_pixels();
 214
 215         /** Get the region end position in pixels relative to session. */
 216         double get_end_position_pixels();
 217
 218         /** Begin resizing of some notes.
 219          * Called by CanvasMidiNote when resizing starts.
 220          * @param at_front which end of the note (true == note on, false == note off)
 221          */
 222         void begin_resizing(bool at_front);
 223
 224         void update_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
 225         void commit_resizing (ArdourCanvas::CanvasNoteEvent*, bool, double, bool);
 226         void abort_resizing ();
 227
 228         /** Change the channel of the selection.
 229          * @param channel - the channel number of the new channel, zero-based
 230          */
 231         void change_channel(uint8_t channel);
 232
 233         enum MouseState {
 234                 None,
 235                 Pressed,
 236                 SelectTouchDragging,
 237                 SelectRectDragging,
 238                 SelectVerticalDragging,
 239                 AddDragging
 240         };
 241
 242         MouseState mouse_state() const { return _mouse_state; }
 243
 244         void note_button_release ();
 245
 246         struct NoteResizeData {
 247                 ArdourCanvas::CanvasNote  *canvas_note;
 248                 ArdourCanvas::SimpleRect  *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          * @return the snapped pixel coordinate relative to region start
 254          */
 255         double snap_to_pixel(double x);
 256
 257         /** Snap a region relative pixel coordinate to frame units.
 258          * @param x a pixel coordinate relative to region start
 259          * @return the snapped framepos_t coordinate relative to region start
 260          */
 261         framepos_t snap_pixel_to_frame(double x);
 262
 263         /** Convert a timestamp in beats into frames (both relative to region position) */
 264         framepos_t region_beats_to_region_frames(double beats) const;
 265         /** Convert a timestamp in beats into absolute frames */
 266         framepos_t region_beats_to_absolute_frames(double beats) const {
 267                 return _region->position() + region_beats_to_region_frames (beats);
 268         }
 269         /** Convert a timestamp in frames to beats (both relative to region position) */
 270         double region_frames_to_region_beats(framepos_t) const;
 271
 272         /** Convert a timestamp in beats measured from source start into absolute frames */
 273         framepos_t source_beats_to_absolute_frames(double beats) const;
 274         /** Convert a timestamp in beats measured from source start into region-relative frames */
 275         framepos_t source_beats_to_region_frames(double beats) const {
 276                 return source_beats_to_absolute_frames (beats) - _region->position();
 277         }
 278         /** Convert a timestamp in absolute frames to beats measured from source start*/
 279         double absolute_frames_to_source_beats(framepos_t) const;
 280
 281         void goto_previous_note (bool add_to_selection);
 282         void goto_next_note (bool add_to_selection);
 283         void change_note_lengths (bool, bool, Evoral::MusicalTime beats, bool start, bool end);
 284         void change_velocities (bool up, bool fine, bool allow_smush, bool all_together);
 285         void transpose (bool up, bool fine, bool allow_smush);
 286         void nudge_notes (bool forward);
 287         void channel_edit ();
 288         void velocity_edit ();
 289
 290         void show_list_editor ();
 291
 292         typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
 293         Selection selection () const {
 294                 return _selection;
 295         }
 296
 297         void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
 298
 299         void enable_display (bool);
 300
 301         void set_channel_selector_scoped_note(ArdourCanvas::CanvasNoteEvent* note){ _channel_selection_scoped_note = note; }
 302         ArdourCanvas::CanvasNoteEvent* channel_selector_scoped_note(){  return _channel_selection_scoped_note; }
 303
 304         void trim_front_starting ();
 305         void trim_front_ending ();
 306
 307         void create_note_at (framepos_t, double, double, bool);
 308
 309         void clear_selection (bool signal = true) { clear_selection_except (0, signal); }
 310
 311         ARDOUR::InstrumentInfo& instrument_info() const;
 312
 313 protected:
 314         /** Allows derived types to specify their visibility requirements
 315          * to the TimeAxisViewItem parent class.
 316          */
 317         MidiRegionView (ArdourCanvas::Group *,
 318                         RouteTimeAxisView&,
 319                         boost::shared_ptr<ARDOUR::MidiRegion>,
 320                         double samples_per_unit,
 321                         Gdk::Color& basic_color,
 322                         TimeAxisViewItem::Visibility);
 323
 324         void region_resized (const PBD::PropertyChange&);
 325
 326         void set_flags (XMLNode *);
 327         void store_flags ();
 328
 329         void reset_width_dependent_items (double pixel_width);
 330
 331         void parameter_changed (std::string const & p);
 332
 333 private:
 334
 335         friend class MidiRubberbandSelectDrag;
 336         friend class MidiVerticalSelectDrag;
 337
 338         /** Emitted when the selection has been cleared in one MidiRegionView,
 339          *  with the expectation that others will clear their selections in
 340          *  sympathy.
 341          */
 342         static PBD::Signal1<void, MidiRegionView*> SelectionCleared;
 343         PBD::ScopedConnection _selection_cleared_connection;
 344         void selection_cleared (MidiRegionView *);
 345
 346         friend class EditNoteDialog;
 347
 348         /** Play the NoteOn event of the given note immediately
 349          * and schedule the playback of the corresponding NoteOff event.
 350          */
 351         void play_midi_note (boost::shared_ptr<NoteType> note);
 352         void start_playing_midi_note (boost::shared_ptr<NoteType> note);
 353         void start_playing_midi_chord (std::vector<boost::shared_ptr<NoteType> > notes);
 354
 355         void clear_events (bool with_selection_signal = true);
 356
 357         bool canvas_event(GdkEvent* ev);
 358         bool note_canvas_event(GdkEvent* ev);
 359
 360         void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
 361         void instrument_settings_changed ();
 362         PBD::ScopedConnection _instrument_changed_connection;
 363
 364         void change_note_channel (ArdourCanvas::CanvasNoteEvent *, int8_t, bool relative=false);
 365         void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
 366         void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
 367         void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
 368         void change_note_length (ArdourCanvas::CanvasNoteEvent *, ARDOUR::MidiModel::TimeType);
 369         void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
 370                        ARDOUR::MidiModel::TimeType end_delta);
 371
 372         void clear_selection_except (ArdourCanvas::CanvasNoteEvent* ev, bool signal = true);
 373         void update_drag_selection (double last_x, double x, double last_y, double y, bool extend);
 374         void update_vertical_drag_selection (double last_y, double y, bool extend);
 375
 376         void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
 377         void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
 378
 379         void show_verbose_cursor (std::string const &, double, double) const;
 380         void show_verbose_cursor (boost::shared_ptr<NoteType>) const;
 381
 382         ARDOUR::ChannelMode _last_channel_mode;
 383         uint16_t _last_channel_selection;
 384
 385         uint8_t  _current_range_min;
 386         uint8_t  _current_range_max;
 387
 388         typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
 389         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasPatchChange> > PatchChanges;
 390         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
 391
 392         boost::shared_ptr<ARDOUR::MidiModel> _model;
 393         Events                               _events;
 394         PatchChanges                         _patch_changes;
 395         SysExes                              _sys_exes;
 396         ArdourCanvas::CanvasNote**           _active_notes;
 397         ArdourCanvas::Group*                 _note_group;
 398         ARDOUR::MidiModel::NoteDiffCommand*  _note_diff_command;
 399         ArdourCanvas::CanvasNote*            _ghost_note;
 400         double                               _last_ghost_x;
 401         double                               _last_ghost_y;
 402         ArdourCanvas::SimpleRect*            _step_edit_cursor;
 403         Evoral::MusicalTime                  _step_edit_cursor_width;
 404         Evoral::MusicalTime                  _step_edit_cursor_position;
 405         ArdourCanvas::CanvasNoteEvent*       _channel_selection_scoped_note;
 406
 407
 408         /** A group used to temporarily reparent _note_group to during start trims, so
 409          *  that the notes don't move with the parent region view.
 410          */
 411         ArdourCanvas::Group*                 _temporary_note_group;
 412
 413         MouseState _mouse_state;
 414         int _pressed_button;
 415
 416         /** Currently selected CanvasNoteEvents */
 417         Selection _selection;
 418
 419         bool _sort_needed;
 420         void time_sort_events ();
 421
 422         MidiCutBuffer* selection_as_cut_buffer () const;
 423
 424         /** New notes (created in the current command) which should be selected
 425          * when they appear after the command is applied. */
 426         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 427
 428         /** New notes (created in the current command) which should have visible velocity
 429          * when they appear after the command is applied. */
 430         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 431
 432         std::vector<NoteResizeData *> _resize_data;
 433
 434         /** connection used to connect to model's ContentChanged signal */
 435         PBD::ScopedConnection content_connection;
 436
 437         ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
 438         Events::iterator _optimization_iterator;
 439
 440         void update_note (ArdourCanvas::CanvasNote *, bool update_ghost_regions = true);
 441         double update_hit (ArdourCanvas::CanvasHit *);
 442         void create_ghost_note (double, double);
 443         void update_ghost_note (double, double);
 444
 445         MidiListEditor* _list_editor;
 446         bool _no_sound_notes;
 447
 448         PBD::ScopedConnection note_delete_connection;
 449         void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
 450
 451         void snap_changed ();
 452         PBD::ScopedConnection snap_changed_connection;
 453
 454         bool motion (GdkEventMotion*);
 455         bool scroll (GdkEventScroll*);
 456         bool key_press (GdkEventKey*);
 457         bool key_release (GdkEventKey*);
 458         bool button_press (GdkEventButton*);
 459         bool button_release (GdkEventButton*);
 460         bool enter_notify (GdkEventCrossing*);
 461         bool leave_notify (GdkEventCrossing*);
 462
 463         void drop_down_keys ();
 464         void maybe_select_by_position (GdkEventButton* ev, double x, double y);
 465         void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
 466
 467         void display_patch_changes_on_channel (uint8_t, bool);
 468
 469         void connect_to_diskstream ();
 470         void data_recorded (boost::weak_ptr<ARDOUR::MidiSource>);
 471
 472         void remove_ghost_note ();
 473         void mouse_mode_changed ();
 474         double _last_event_x;
 475         double _last_event_y;
 476
 477         framepos_t snap_frame_to_grid_underneath (framepos_t p, framecnt_t &) const;
 478
 479         PBD::ScopedConnection _mouse_mode_connection;
 480
 481         Gdk::Cursor* pre_enter_cursor;
 482         Gdk::Cursor* pre_press_cursor;
 483
 484         NotePlayer* _note_player;
 485 };
 486
 487
 488 #endif /* __gtk_ardour_midi_region_view_h__ */