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