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
  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         inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
  88                 { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
  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
  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 (nframes64_t pos, float times, const MidiCutBuffer&);
 121
 122         struct PCEvent {
 123                 PCEvent(double a_time, uint8_t a_value, uint8_t a_channel)
 124                         : time(a_time), value(a_value), channel(a_channel) {}
 125
 126                 double  time;
 127                 uint8_t value;
 128                 uint8_t channel;
 129         };
 130
 131         /** Add a new program change flag to the canvas.
 132          * @param program the MidiRegionView::PCEvent to add
 133          * @param the text to display in the flag
 134          */
 135         void add_pgm_change(PCEvent& program, const std::string& displaytext);
 136
 137         /** Look up the given time and channel in the 'automation' and set keys accordingly.
 138          * @param time the time of the program change event
 139          * @param channel the MIDI channel of the event
 140          * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
 141          *        will be set according to the result of the lookup
 142          */
 143         void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
 144
 145         /** Change the 'automation' data of old_program to new values which correspond to new_patch.
 146          * @param old_program the program change event which is to be altered
 147          * @param new_patch the new lsb, msb and program number which are to be set
 148          */
 149         void alter_program_change(PCEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
 150
 151         /** Alter a given program to the new given one.
 152          * (Called on context menu select on CanvasProgramChange)
 153          */
 154         void program_selected(
 155                 ArdourCanvas::CanvasProgramChange& program,
 156                 const MIDI::Name::PatchPrimaryKey& new_patch);
 157
 158         /** Alter a given program to be its predecessor in the MIDNAM file.
 159          */
 160         void previous_program(ArdourCanvas::CanvasProgramChange& program);
 161
 162         /** Alters a given program to be its successor in the MIDNAM file.
 163          */
 164         void next_program(ArdourCanvas::CanvasProgramChange& program);
 165
 166         /** Displays all program change events in the region as flags on the canvas.
 167          */
 168         void display_program_changes();
 169
 170         /** Displays all system exclusive events in the region as flags on the canvas.
 171          */
 172         void display_sysexes();
 173
 174         void begin_write();
 175         void end_write();
 176         void extend_active_notes();
 177
 178         void create_note_at(double x, double y, double length, bool);
 179
 180         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
 181
 182         void start_diff_command(std::string name = "midi edit");
 183         void diff_add_change(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::DiffCommand::Property, uint8_t val);
 184         void diff_add_change(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::DiffCommand::Property, Evoral::MusicalTime val);
 185         void diff_add_note(const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity=false);
 186         void diff_remove_note(ArdourCanvas::CanvasNoteEvent* ev);
 187
 188         void apply_diff();
 189         void apply_diff_as_subcommand();
 190         void abort_command();
 191
 192         void   note_entered(ArdourCanvas::CanvasNoteEvent* ev);
 193         void   note_left(ArdourCanvas::CanvasNoteEvent* ev);
 194         void   unique_select(ArdourCanvas::CanvasNoteEvent* ev);
 195         void   note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add, bool extend=false);
 196         void   note_deselected(ArdourCanvas::CanvasNoteEvent* ev);
 197         void   delete_selection();
 198         void   delete_note (boost::shared_ptr<NoteType>);
 199         size_t selection_size() { return _selection.size(); }
 200
 201         void move_selection(double dx, double dy);
 202         void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double d_pixels, 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::CanvasNote *, bool, double, bool);
 225         void commit_resizing (ArdourCanvas::CanvasNote *, bool, double, bool);
 226
 227         /** Adjust the velocity on a note, and the selection if applicable.
 228          * @param velocity the relative or absolute velocity
 229          * @param relative whether velocity is relative or absolute
 230          */
 231         void change_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
 232
 233         /** Change the channel of the selection.
 234          * @param channel - the channel number of the new channel, zero-based
 235          */
 236         void change_channel(uint8_t channel);
 237
 238         enum MouseState {
 239                 None,
 240                 Pressed,
 241                 SelectTouchDragging,
 242                 SelectRectDragging,
 243                 AddDragging
 244         };
 245
 246         MouseState mouse_state() const { return _mouse_state; }
 247
 248         struct NoteResizeData {
 249                 ArdourCanvas::CanvasNote  *canvas_note;
 250                 ArdourCanvas::SimpleRect  *resize_rect;
 251         };
 252
 253         /** Snap a region relative pixel coordinate to pixel units.
 254          * @param x a pixel coordinate relative to region start
 255          * @return the snapped pixel coordinate relative to region start
 256          */
 257         double snap_to_pixel(double x);
 258
 259         /** Snap a region relative pixel coordinate to frame units.
 260          * @param x a pixel coordinate relative to region start
 261          * @return the snapped nframes64_t coordinate relative to region start
 262          */
 263         nframes64_t snap_pixel_to_frame(double x);
 264
 265         /** Snap a region relative frame coordinate to frame units.
 266          * @param x a pixel coordinate relative to region start
 267          * @return the snapped nframes64_t coordinate relative to region start
 268          */
 269         nframes64_t snap_frame_to_frame(nframes64_t x);
 270
 271         /** Convert a timestamp in beats to frames (both relative to region start) */
 272         nframes64_t beats_to_frames(double beats) const;
 273
 274         /** Convert a timestamp in frames to beats (both relative to region start) */
 275         double frames_to_beats(nframes64_t) const;
 276
 277         void goto_previous_note ();
 278         void goto_next_note ();
 279         void change_note_lengths (bool, bool, bool start, bool end);
 280         void change_velocities (bool up, bool fine, bool allow_smush);
 281         void transpose (bool up, bool fine, bool allow_smush);
 282         void nudge_notes (bool forward);
 283
 284         void show_list_editor ();
 285
 286         void selection_as_notelist (Notes& selected, bool allow_all_if_none_selected = false);
 287
 288         void enable_display (bool);
 289
 290   protected:
 291         /** Allows derived types to specify their visibility requirements
 292          * to the TimeAxisViewItem parent class.
 293          */
 294         MidiRegionView (ArdourCanvas::Group *,
 295                         RouteTimeAxisView&,
 296                         boost::shared_ptr<ARDOUR::MidiRegion>,
 297                         double samples_per_unit,
 298                         Gdk::Color& basic_color,
 299                         TimeAxisViewItem::Visibility);
 300
 301         void region_resized (const PBD::PropertyChange&);
 302
 303         void set_flags (XMLNode *);
 304         void store_flags ();
 305
 306         void reset_width_dependent_items (double pixel_width);
 307
 308   private:
 309         /** Play the NoteOn event of the given note immediately
 310          * and schedule the playback of the corresponding NoteOff event.
 311          */
 312         void play_midi_note(boost::shared_ptr<NoteType> note);
 313
 314         /** Play the NoteOff-Event of the given note immediately
 315          * (scheduled by @ref play_midi_note()).
 316          */
 317         bool play_midi_note_off(boost::shared_ptr<NoteType> note);
 318
 319         void clear_events();
 320         void switch_source(boost::shared_ptr<ARDOUR::Source> src);
 321
 322         bool canvas_event(GdkEvent* ev);
 323         bool note_canvas_event(GdkEvent* ev);
 324
 325         void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
 326         void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
 327
 328         void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
 329         void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
 330         void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
 331         void trim_note(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType start_delta,
 332                        ARDOUR::MidiModel::TimeType end_delta);
 333
 334         void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
 335         void clear_selection() { clear_selection_except(NULL); }
 336         void update_drag_selection(double last_x, double x, double last_y, double y);
 337
 338         void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
 339         void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
 340
 341         int8_t   _force_channel;
 342         uint16_t _last_channel_selection;
 343         uint8_t  _current_range_min;
 344         uint8_t  _current_range_max;
 345
 346         /// MIDNAM information of the current track: Model name of MIDNAM file
 347         std::string _model_name;
 348
 349         /// MIDNAM information of the current track: CustomDeviceMode
 350         std::string _custom_device_mode;
 351
 352         typedef std::list<ArdourCanvas::CanvasNoteEvent*> Events;
 353         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
 354         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
 355
 356         boost::shared_ptr<ARDOUR::MidiModel> _model;
 357         Events                               _events;
 358         PgmChanges                           _pgm_changes;
 359         SysExes                              _sys_exes;
 360         ArdourCanvas::CanvasNote**           _active_notes;
 361         ArdourCanvas::Group*                 _note_group;
 362         ARDOUR::MidiModel::DiffCommand*      _diff_command;
 363         ArdourCanvas::CanvasNote*            _ghost_note;
 364         double                               _last_ghost_x;
 365         double                               _last_ghost_y;
 366         double                               _drag_start_x;
 367         double                               _drag_start_y;
 368         double                               _last_x;
 369         double                               _last_y;
 370         ArdourCanvas::SimpleRect*            _drag_rect;
 371         ArdourCanvas::SimpleRect*            _step_edit_cursor;
 372         double                               _step_edit_cursor_width;
 373
 374         MouseState _mouse_state;
 375         int _pressed_button;
 376
 377         typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
 378         /// Currently selected CanvasNoteEvents
 379         Selection _selection;
 380
 381         bool _sort_needed;
 382         void time_sort_events ();
 383
 384         MidiCutBuffer* selection_as_cut_buffer () const;
 385
 386         /** New notes (created in the current command) which should be selected
 387          * when they appear after the command is applied. */
 388         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 389
 390         /** New notes (created in the current command) which should have visible velocity
 391          * when they appear after the command is applied. */
 392         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 393
 394         std::vector<NoteResizeData *> _resize_data;
 395
 396         /* connection used to connect to model's ContentChanged signal */
 397         PBD::ScopedConnection content_connection;
 398
 399         ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
 400         Events::iterator _optimization_iterator;
 401
 402         void update_note (ArdourCanvas::CanvasNote*);
 403         void update_hit (ArdourCanvas::CanvasHit*);
 404         void create_ghost_note (double, double);
 405         void update_ghost_note (double, double);
 406
 407         MidiListEditor* _list_editor;
 408         bool no_sound_notes;
 409
 410         PBD::ScopedConnection note_delete_connection;
 411         void maybe_remove_deleted_note_from_selection (ArdourCanvas::CanvasNoteEvent*);
 412
 413         void snap_changed ();
 414         PBD::ScopedConnection snap_changed_connection;
 415
 416         void show_verbose_canvas_cursor (boost::shared_ptr<NoteType>) const;
 417
 418         bool motion (GdkEventMotion*);
 419         bool scroll (GdkEventScroll*);
 420         bool key_press (GdkEventKey*);
 421         bool key_release (GdkEventKey*);
 422         bool button_press (GdkEventButton*);
 423         bool button_release (GdkEventButton*);
 424         bool enter_notify (GdkEventCrossing*);
 425         bool leave_notify (GdkEventCrossing*);
 426
 427         void drop_down_keys ();
 428         void maybe_select_by_position (GdkEventButton* ev, double x, double y);
 429         void get_events (Events& e, Evoral::Sequence<Evoral::MusicalTime>::NoteOperator op, uint8_t val, int chan_mask = 0);
 430
 431         void display_program_changes_on_channel (uint8_t);
 432
 433 };
 434
 435
 436 #endif /* __gtk_ardour_midi_region_view_h__ */