gtk2_ardour/midi_region_view.h

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