gtk2_ardour/midi_region_view.h

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