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         size_t selection_size() { return _selection.size(); }
 197
 198         void move_selection(double dx, double dy);
 199         void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double d_pixels, int8_t d_note);
 200
 201         /** Return true iff the note is within the extent of the region.
 202          * @param visible will be set to true if the note is within the visible note range, false otherwise.
 203          */
 204         bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
 205
 206         /** Get the region position in pixels relative to session. */
 207         double get_position_pixels();
 208
 209         /** Get the region end position in pixels relative to session. */
 210         double get_end_position_pixels();
 211
 212         /** Begin resizing of some notes.
 213          * Called by CanvasMidiNote when resizing starts.
 214          * @param at_front which end of the note (true == note on, false == note off)
 215          */
 216         void begin_resizing(bool at_front);
 217
 218         /** Update resizing notes while user drags.
 219          * @param at_front which end of the note (true == note on, false == note off)
 220          * @param x the difference in mouse motion, ie the motion difference if relative=true
 221          *           or the absolute mouse position (track-relative) if relative is false
 222          * @param relative true if relative resizing is taking place, false if absolute resizing
 223          */
 224         void update_resizing(bool at_front, double x, bool relative);
 225
 226         /** Finish resizing notes when the user releases the mouse button.
 227          * @param at_front which end of the note (true == note on, false == note off)
 228          * @param event_x the absolute mouse position (track-relative)
 229          * @param relative true if relative resizing is taking place, false if absolute resizing
 230          */
 231         void commit_resizing(bool at_front, double event_x, bool relative);
 232
 233         /** Adjust the velocity on a note, and the selection if applicable.
 234          * @param velocity the relative or absolute velocity
 235          * @param relative whether velocity is relative or absolute
 236          */
 237         void change_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
 238
 239         /** Change the channel of the selection.
 240          * @param channel - the channel number of the new channel, zero-based
 241          */
 242         void change_channel(uint8_t channel);
 243
 244         enum MouseState {
 245                 None,
 246                 Pressed,
 247                 SelectTouchDragging,
 248                 SelectRectDragging,
 249                 AddDragging
 250         };
 251
 252         MouseState mouse_state() const { return _mouse_state; }
 253
 254         struct NoteResizeData {
 255                 ArdourCanvas::CanvasNote  *canvas_note;
 256                 ArdourCanvas::SimpleRect  *resize_rect;
 257         };
 258
 259         /** Snap a region relative pixel coordinate to pixel units.
 260          * @param x a pixel coordinate relative to region start
 261          * @return the snapped pixel coordinate relative to region start
 262          */
 263         double snap_to_pixel(double x);
 264
 265         /** Snap a region relative pixel 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_pixel_to_frame(double x);
 270
 271         /** Snap a region relative frame coordinate to frame units.
 272          * @param x a pixel coordinate relative to region start
 273          * @return the snapped nframes64_t coordinate relative to region start
 274          */
 275         nframes64_t snap_frame_to_frame(nframes64_t x);
 276
 277         /** Convert a timestamp in beats to frames (both relative to region start) */
 278         nframes64_t beats_to_frames(double beats) const;
 279
 280         /** Convert a timestamp in frames to beats (both relative to region start) */
 281         double frames_to_beats(nframes64_t beats) const;
 282
 283         void goto_previous_note ();
 284         void goto_next_note ();
 285         void change_note_lengths (bool, bool, bool start, bool end);
 286         void change_velocities (bool up, bool fine, bool allow_smush);
 287         void transpose (bool up, bool fine, bool allow_smush);
 288         void nudge_notes (bool forward);
 289
 290         void show_list_editor ();
 291
 292         void selection_as_notelist (Notes& selected);
 293
 294   protected:
 295         /** Allows derived types to specify their visibility requirements
 296          * to the TimeAxisViewItem parent class.
 297          */
 298         MidiRegionView (ArdourCanvas::Group *,
 299                         RouteTimeAxisView&,
 300                         boost::shared_ptr<ARDOUR::MidiRegion>,
 301                         double samples_per_unit,
 302                         Gdk::Color& basic_color,
 303                         TimeAxisViewItem::Visibility);
 304
 305         void region_resized (ARDOUR::Change);
 306
 307         void set_flags (XMLNode *);
 308         void store_flags ();
 309
 310         void reset_width_dependent_items (double pixel_width);
 311
 312   private:
 313         /** Play the NoteOn event of the given note immediately
 314          * and schedule the playback of the corresponding NoteOff event.
 315          */
 316         void play_midi_note(boost::shared_ptr<NoteType> note);
 317
 318         /** Play the NoteOff-Event of the given note immediately
 319          * (scheduled by @ref play_midi_note()).
 320          */
 321         bool play_midi_note_off(boost::shared_ptr<NoteType> note);
 322
 323         void clear_events();
 324         void switch_source(boost::shared_ptr<ARDOUR::Source> src);
 325
 326         bool canvas_event(GdkEvent* ev);
 327         bool note_canvas_event(GdkEvent* ev);
 328
 329         void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
 330         void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
 331
 332         void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
 333         void change_note_note(ArdourCanvas::CanvasNoteEvent* ev, int8_t note, bool relative=false);
 334         void change_note_time(ArdourCanvas::CanvasNoteEvent* ev, ARDOUR::MidiModel::TimeType, bool relative=false);
 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         double   _default_note_length;
 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::DeltaCommand*     _delta_command;
 368         ARDOUR::MidiModel::DiffCommand*      _diff_command;
 369
 370         MouseState _mouse_state;
 371         int _pressed_button;
 372
 373         typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
 374         /// Currently selected CanvasNoteEvents
 375         Selection _selection;
 376
 377         bool _sort_needed;
 378         void time_sort_events ();
 379
 380         MidiCutBuffer* selection_as_cut_buffer () const;
 381
 382         /** New notes (created in the current command) which should be selected
 383          * when they appear after the command is applied. */
 384         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 385
 386         /** New notes (created in the current command) which should have visible velocity
 387          * when they appear after the command is applied. */
 388         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 389
 390         std::vector<NoteResizeData *> _resize_data;
 391
 392         /* connection used to connect to model's ContentChanged signal */
 393         PBD::ScopedConnection content_connection;
 394
 395         ArdourCanvas::CanvasNoteEvent* find_canvas_note (boost::shared_ptr<NoteType>);
 396         Events::iterator _optimization_iterator;
 397
 398         void update_note (ArdourCanvas::CanvasNote*);
 399         void update_hit (ArdourCanvas::CanvasHit*);
 400
 401         MidiListEditor* _list_editor;
 402 };
 403
 404
 405 #endif /* __gtk_ardour_midi_region_view_h__ */