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