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