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