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 #include "ardour/midi_track.h"
  28 #include "ardour/midi_region.h"
  29 #include "ardour/midi_model.h"
  30 #include "ardour/diskstream.h"
  31 #include "ardour/types.h"
  32
  33 #include "editing.h"
  34 #include "region_view.h"
  35 #include "midi_time_axis.h"
  36 #include "time_axis_view_item.h"
  37 #include "automation_line.h"
  38 #include "enums.h"
  39 #include "canvas.h"
  40 #include "canvas-note.h"
  41 #include "canvas-note-event.h"
  42 #include "canvas-program-change.h"
  43 #include "canvas-sysex.h"
  44
  45 namespace ARDOUR {
  46         class MidiRegion;
  47         class MidiModel;
  48 };
  49
  50 namespace MIDI {
  51         namespace Name {
  52                 struct PatchPrimaryKey;
  53         };
  54 };
  55
  56 class MidiTimeAxisView;
  57 class GhostRegion;
  58 class AutomationTimeAxisView;
  59 class AutomationRegionView;
  60
  61 class MidiRegionView : public RegionView
  62 {
  63   public:
  64         typedef Evoral::Note<ARDOUR::MidiModel::TimeType> NoteType;
  65
  66         MidiRegionView (ArdourCanvas::Group *,
  67                         RouteTimeAxisView&,
  68                         boost::shared_ptr<ARDOUR::MidiRegion>,
  69                         double initial_samples_per_unit,
  70                         Gdk::Color const & basic_color);
  71
  72         MidiRegionView (const MidiRegionView& other);
  73         MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
  74
  75         ~MidiRegionView ();
  76
  77         virtual void init (Gdk::Color const & basic_color, bool wfd);
  78
  79         inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
  80                 { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
  81
  82         inline MidiTimeAxisView* midi_view() const
  83                 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
  84
  85         inline MidiStreamView* midi_stream_view() const
  86                 { return midi_view()->midi_view(); }
  87
  88         void set_height (double);
  89         void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
  90
  91         inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
  92
  93         void set_frame_color();
  94
  95         void redisplay_model();
  96
  97         GhostRegion* add_ghost (TimeAxisView&);
  98
  99         void add_note(const boost::shared_ptr<NoteType> note);
 100         void resolve_note(uint8_t note_num, double end_time);
 101
 102         void cut_copy_clear (Editing::CutCopyOp);
 103
 104         struct PCEvent {
 105                 PCEvent(double a_time, uint8_t a_value, uint8_t a_channel)
 106                         : time(a_time), value(a_value), channel(a_channel) {}
 107
 108                 double  time;
 109                 uint8_t value;
 110                 uint8_t channel;
 111         };
 112
 113         /** Add a new program change flag to the canvas.
 114          * @param program the MidiRegionView::PCEvent to add
 115          * @param the text to display in the flag
 116          */
 117         void add_pgm_change(PCEvent& program, const std::string& displaytext);
 118
 119         /** Look up the given time and channel in the 'automation' and set keys accordingly.
 120          * @param time the time of the program change event
 121          * @param channel the MIDI channel of the event
 122          * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
 123          *        will be set according to the result of the lookup
 124          */
 125         void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
 126
 127         /** Change the 'automation' data of old_program to new values which correspond to new_patch.
 128          * @param old_program the program change event which is to be altered
 129          * @param new_patch the new lsb, msb and program number which are to be set
 130          */
 131         void alter_program_change(PCEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
 132
 133         /** Alter a given program to the new given one.
 134          * (Called on context menu select on CanvasProgramChange)
 135          */
 136         void program_selected(
 137                 ArdourCanvas::CanvasProgramChange& program,
 138                 const MIDI::Name::PatchPrimaryKey& new_patch);
 139
 140         /** Alter a given program to be its predecessor in the MIDNAM file.
 141          */
 142         void previous_program(ArdourCanvas::CanvasProgramChange& program);
 143
 144         /** Alters a given program to be its successor in the MIDNAM file.
 145          */
 146         void next_program(ArdourCanvas::CanvasProgramChange& program);
 147
 148         /** Displays all program change events in the region as flags on the canvas.
 149          */
 150         void display_program_changes();
 151
 152         /** Displays all system exclusive events in the region as flags on the canvas.
 153          */
 154         void display_sysexes();
 155
 156         void begin_write();
 157         void end_write();
 158         void extend_active_notes();
 159
 160         void create_note_at(double x, double y, double length);
 161
 162         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
 163
 164         void start_delta_command(std::string name = "midi edit");
 165         void command_add_note(const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity=false);
 166         void command_remove_note(ArdourCanvas::CanvasNoteEvent* ev);
 167
 168         void apply_command();
 169         void abort_command();
 170
 171         void   note_entered(ArdourCanvas::CanvasNoteEvent* ev);
 172         void   unique_select(ArdourCanvas::CanvasNoteEvent* ev);
 173         void   note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add);
 174         void   note_deselected(ArdourCanvas::CanvasNoteEvent* ev, bool add);
 175         void   delete_selection();
 176         size_t selection_size() { return _selection.size(); }
 177
 178         void move_selection(double dx, double dy);
 179         void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double d_pixels, uint8_t d_note);
 180
 181         /** Return true iff the note is within the currently visible range */
 182         bool note_in_visible_range(const boost::shared_ptr<NoteType> note) const;
 183
 184         /** Get the region position in pixels relative to session. */
 185         double get_position_pixels();
 186
 187         /** Begin resizing of some notes.
 188          * Called by CanvasMidiNote when resizing starts.
 189          * @param note_end which end of the note, NOTE_ON or NOTE_OFF
 190          */
 191         void begin_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end);
 192
 193         /** Update resizing notes while user drags.
 194          * @param note_end which end of the note, NOTE_ON or NOTE_OFF
 195          * @param x the difference in mouse motion, ie the motion difference if relative=true
 196          *           or the absolute mouse position (track-relative) if relative is false
 197          * @param relative true if relative resizing is taking place, false if absolute resizing
 198          */
 199         void update_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end, double x, bool relative);
 200
 201         /** Finish resizing notes when the user releases the mouse button.
 202          * @param note_end which end of the note, NOTE_ON or NOTE_OFF
 203          * @param event_x the absolute mouse position (track-relative)
 204          * @param relative true if relative resizing is taking place, false if absolute resizing
 205          */
 206         void commit_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end, double event_x, bool relative);
 207
 208         /** Adjust the velocity on a note, and the selection if applicable.
 209          * @param velocity the relative or absolute velocity
 210          * @param relative whether velocity is relative or absolute
 211          */
 212         void change_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
 213
 214         /** Change the channel of the selection.
 215          * @param channel - the channel number of the new channel, zero-based
 216          */
 217         void change_channel(uint8_t channel);
 218
 219         enum MouseState {
 220                 None,
 221                 Pressed,
 222                 SelectTouchDragging,
 223                 SelectRectDragging,
 224                 AddDragging
 225         };
 226
 227         MouseState mouse_state() const { return _mouse_state; }
 228
 229         struct NoteResizeData {
 230                 ArdourCanvas::CanvasNote  *canvas_note;
 231                 ArdourCanvas::SimpleRect  *resize_rect;
 232                 double                     current_x;
 233         };
 234
 235         /** Snap a region relative pixel coordinate to pixel units.
 236          * @param x a pixel coordinate relative to region start
 237          * @return the snapped pixel coordinate relative to region start
 238          */
 239         double snap_to_pixel(double x);
 240
 241         /** Snap a region relative pixel coordinate to frame units.
 242          * @param x a pixel coordinate relative to region start
 243          * @return the snapped nframes64_t coordinate relative to region start
 244          */
 245         nframes64_t snap_pixel_to_frame(double x);
 246
 247         /** Snap a region relative frame coordinate to frame units.
 248          * @param x a pixel coordinate relative to region start
 249          * @return the snapped nframes64_t coordinate relative to region start
 250          */
 251         nframes64_t snap_frame_to_frame(nframes64_t x);
 252
 253         /** Convert a timestamp in beats to frames (both relative to region start) */
 254         nframes64_t beats_to_frames(double beats) const;
 255
 256         /** Convert a timestamp in frames to beats (both relative to region start) */
 257         double frames_to_beats(nframes64_t beats) const;
 258
 259   protected:
 260     /** Allows derived types to specify their visibility requirements
 261      * to the TimeAxisViewItem parent class.
 262      */
 263     MidiRegionView (ArdourCanvas::Group *,
 264                         RouteTimeAxisView&,
 265                         boost::shared_ptr<ARDOUR::MidiRegion>,
 266                         double samples_per_unit,
 267                         Gdk::Color& basic_color,
 268                         TimeAxisViewItem::Visibility);
 269
 270     void region_resized (ARDOUR::Change);
 271
 272     void set_flags (XMLNode *);
 273     void store_flags ();
 274
 275         void reset_width_dependent_items (double pixel_width);
 276
 277   private:
 278         /** Play the NoteOn event of the given note immediately
 279          * and schedule the playback of the corresponding NoteOff event.
 280          */
 281         void play_midi_note(boost::shared_ptr<NoteType> note);
 282
 283         /** Play the NoteOff-Event of the given note immediately
 284          * (scheduled by @ref play_midi_note()).
 285          */
 286         bool play_midi_note_off(boost::shared_ptr<NoteType> note);
 287
 288         void clear_events();
 289         void switch_source(boost::shared_ptr<ARDOUR::Source> src);
 290
 291         bool canvas_event(GdkEvent* ev);
 292         bool note_canvas_event(GdkEvent* ev);
 293
 294         void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
 295         void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
 296
 297         void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
 298
 299         void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
 300         void clear_selection() { clear_selection_except(NULL); }
 301         void update_drag_selection(double last_x, double x, double last_y, double y);
 302
 303         void add_to_selection (ArdourCanvas::CanvasNoteEvent*);
 304         void remove_from_selection (ArdourCanvas::CanvasNoteEvent*);
 305
 306         int8_t   _force_channel;
 307         uint16_t _last_channel_selection;
 308         double   _default_note_length;
 309         uint8_t  _current_range_min;
 310         uint8_t  _current_range_max;
 311
 312         /// MIDNAM information of the current track: Model name of MIDNAM file
 313         std::string _model_name;
 314
 315         /// MIDNAM information of the current track: CustomDeviceMode
 316         std::string _custom_device_mode;
 317
 318         typedef std::vector<ArdourCanvas::CanvasNoteEvent*> Events;
 319         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
 320         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
 321
 322         boost::shared_ptr<ARDOUR::MidiModel> _model;
 323         Events                               _events;
 324         PgmChanges                           _pgm_changes;
 325         SysExes                              _sys_exes;
 326         ArdourCanvas::CanvasNote**           _active_notes;
 327         ArdourCanvas::Group*                 _note_group;
 328         ARDOUR::MidiModel::DeltaCommand*     _delta_command;
 329
 330         MouseState _mouse_state;
 331         int _pressed_button;
 332
 333         typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
 334         /// Currently selected CanvasNoteEvents
 335         Selection _selection;
 336         /// the cut buffer for this region view
 337         typedef std::list<NoteType> CutBuffer;
 338         CutBuffer _cut_buffer;
 339
 340         /** New notes (created in the current command) which should be selected
 341          * when they appear after the command is applied. */
 342         std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
 343
 344         /** New notes (created in the current command) which should have visible velocity
 345          * when they appear after the command is applied. */
 346         std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 347
 348         std::vector<NoteResizeData *> _resize_data;
 349 };
 350
 351 #endif /* __gtk_ardour_midi_region_view_h__ */