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 <vector>
  23
  24 #include <libgnomecanvasmm.h>
  25 #include <libgnomecanvasmm/polygon.h>
  26 #include <ardour/midi_track.h>
  27 #include <ardour/midi_region.h>
  28 #include <ardour/midi_model.h>
  29 #include <ardour/diskstream.h>
  30 #include <ardour/types.h>
  31
  32 #include "region_view.h"
  33 #include "midi_time_axis.h"
  34 #include "time_axis_view_item.h"
  35 #include "automation_line.h"
  36 #include "enums.h"
  37 #include "canvas.h"
  38 #include "canvas-note.h"
  39 #include "canvas-note-event.h"
  40 #include "canvas-program-change.h"
  41
  42 namespace ARDOUR {
  43         class MidiRegion;
  44         class MidiModel;
  45 };
  46
  47 class MidiTimeAxisView;
  48 class GhostRegion;
  49 class AutomationTimeAxisView;
  50 class AutomationRegionView;
  51
  52 class MidiRegionView : public RegionView
  53 {
  54   public:
  55         MidiRegionView (ArdourCanvas::Group *,
  56                         RouteTimeAxisView&,
  57                         boost::shared_ptr<ARDOUR::MidiRegion>,
  58                         double initial_samples_per_unit,
  59                         Gdk::Color& basic_color);
  60
  61         MidiRegionView (const MidiRegionView& other);
  62         MidiRegionView (const MidiRegionView& other, boost::shared_ptr<ARDOUR::MidiRegion>);
  63
  64         ~MidiRegionView ();
  65
  66         virtual void init (Gdk::Color& basic_color, bool wfd);
  67
  68         inline const boost::shared_ptr<ARDOUR::MidiRegion> midi_region() const
  69                 { return boost::dynamic_pointer_cast<ARDOUR::MidiRegion>(_region); }
  70
  71         inline MidiTimeAxisView* midi_view() const
  72                 { return dynamic_cast<MidiTimeAxisView*>(&trackview); }
  73
  74         inline MidiStreamView* midi_stream_view() const
  75                 { return midi_view()->midi_view(); }
  76
  77         void set_height (double);
  78         void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
  79
  80         void set_frame_color();
  81
  82         void redisplay_model();
  83
  84         GhostRegion* add_ghost (TimeAxisView&);
  85
  86         void add_note(const boost::shared_ptr<Evoral::Note> note);
  87         void resolve_note(uint8_t note_num, double end_time);
  88
  89         void add_pgm_change(boost::shared_ptr<Evoral::Event> event);
  90
  91         void begin_write();
  92         void end_write();
  93         void extend_active_notes();
  94
  95         void create_note_at(double x, double y, double duration);
  96
  97         void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
  98
  99         void start_delta_command(string name = "midi edit");
 100         void command_add_note(const boost::shared_ptr<Evoral::Note> note, bool selected);
 101         void command_remove_note(ArdourCanvas::CanvasNoteEvent* ev);
 102
 103         void apply_command();
 104         void abort_command();
 105
 106         void   note_entered(ArdourCanvas::CanvasNoteEvent* ev);
 107         void   unique_select(ArdourCanvas::CanvasNoteEvent* ev);
 108         void   note_selected(ArdourCanvas::CanvasNoteEvent* ev, bool add);
 109         void   note_deselected(ArdourCanvas::CanvasNoteEvent* ev, bool add);
 110         void   delete_selection();
 111         size_t selection_size() { return _selection.size(); }
 112
 113         void move_selection(double dx, double dy);
 114         void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double dt, uint8_t dnote);
 115
 116         /**
 117          * This function is needed to subtract the region start in pixels
 118          * from world coordinates submitted by the mouse
 119          */
 120         double get_position_pixels(void);
 121
 122         /**
 123          * This function is called by CanvasMidiNote when resizing starts,
 124          * i.e. when the user presses mouse-2 on the note
 125          * @param note_end which end of the note, NOTE_ON or NOTE_OFF
 126          */
 127         void  begin_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end);
 128
 129         /**
 130          * This function is called while the user moves the mouse when resizing notes
 131          * @param note_end which end of the note, NOTE_ON or NOTE_OFF
 132          * @param x the difference in mouse motion, ie the motion difference if relative=true
 133          *           or the absolute mouse position (track-relative) if relative is false
 134          * @param relative true if relative resizing is taking place, false if absolute resizing
 135          */
 136         void update_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end, double x, bool relative);
 137
 138         /**
 139          * This function is called while the user releases the mouse button when resizing notes
 140          * @param note_end which end of the note, NOTE_ON or NOTE_OFF
 141          * @param event_x the absolute mouse position (track-relative)
 142          * @param relative true if relative resizing is taking place, false if absolute resizing
 143          */
 144         void commit_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end, double event_x, bool relative);
 145
 146         /**
 147          * This function is called while the user adjusts the velocity on a selection of notes
 148          * @param velocity the relative or absolute velocity, depending on the value of relative
 149          * @param relative true if the given velocity represents a delta to be applied to all notes, false
 150          *        if the absolute value of the note shoud be set
 151          */
 152         void change_velocity(uint8_t velocity, bool relative=false);
 153
 154         /**
 155          * This function is called when the user adjusts the midi channel of a selection of notes
 156          * @param channel - the channel number of the new channel, zero-based
 157          */
 158         void change_channel(uint8_t channel);
 159
 160         enum MouseState { None, Pressed, SelectTouchDragging, SelectRectDragging, AddDragging, EraseTouchDragging };
 161         MouseState mouse_state() const { return _mouse_state; }
 162
 163         struct NoteResizeData {
 164                 ArdourCanvas::CanvasNote  *canvas_note;
 165                 ArdourCanvas::SimpleRect  *resize_rect;
 166                 double                     current_x;
 167         };
 168
 169         /**
 170          * This function provides the snap function for region position relative coordinates
 171          * for pixel units (double) instead of nframes64_t
 172          * @param x a pixel coordinate relative to region start
 173          * @return the snapped pixel coordinate relative to region start
 174          */
 175         double snap_to_pixel(double x);
 176
 177         /**
 178          * This function provides the snap function for region position relative coordinates
 179          * for pixel units (double) instead of nframes64_t
 180          * @param x a pixel coordinate relative to region start
 181          * @return the snapped nframes64_t coordinate relative to region start
 182          */
 183         nframes64_t snap_to_frame(double x);
 184
 185         /**
 186          * This function provides the snap function for region position relative coordinates
 187          * @param x a pixel coordinate relative to region start
 188          * @return the snapped nframes64_t coordinate relative to region start
 189          */
 190         nframes64_t snap_to_frame(nframes64_t x);
 191
 192   protected:
 193
 194     /**
 195      * this constructor allows derived types
 196      * to specify their visibility requirements
 197      * to the TimeAxisViewItem parent class
 198     */
 199     MidiRegionView (ArdourCanvas::Group *,
 200                         RouteTimeAxisView&,
 201                         boost::shared_ptr<ARDOUR::MidiRegion>,
 202                         double samples_per_unit,
 203                         Gdk::Color& basic_color,
 204                         TimeAxisViewItem::Visibility);
 205
 206     void region_resized (ARDOUR::Change);
 207
 208     void set_flags (XMLNode *);
 209     void store_flags ();
 210
 211         void reset_width_dependent_items (double pixel_width);
 212
 213   private:
 214
 215         void clear_events();
 216         void switch_source(boost::shared_ptr<ARDOUR::Source> src);
 217
 218         bool canvas_event(GdkEvent* ev);
 219         bool note_canvas_event(GdkEvent* ev);
 220
 221         void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
 222
 223         void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
 224         void clear_selection() { clear_selection_except(NULL); }
 225         void update_drag_selection(double last_x, double x, double last_y, double y);
 226
 227         int8_t   _force_channel;
 228         uint16_t _last_channel_selection;
 229         double   _default_note_length;
 230         uint8_t  _current_range_min;
 231         uint8_t  _current_range_max;
 232
 233         typedef std::vector<ArdourCanvas::CanvasNoteEvent*> Events;
 234         typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
 235
 236         boost::shared_ptr<ARDOUR::MidiModel> _model;
 237         Events                               _events;
 238         PgmChanges                           _pgm_changes;
 239         ArdourCanvas::CanvasNote**           _active_notes;
 240         ArdourCanvas::Group*                 _note_group;
 241         ARDOUR::MidiModel::DeltaCommand*     _delta_command;
 242
 243         MouseState _mouse_state;
 244         int _pressed_button;
 245
 246         typedef std::set<ArdourCanvas::CanvasNoteEvent*> Selection;
 247         /// Currently selected CanvasNoteEvents
 248         Selection _selection;
 249
 250         /** New notes (created in the current command) which should be selected
 251          * when they appear after the command is applied. */
 252         std::set< boost::shared_ptr<Evoral::Note> > _marked_for_selection;
 253
 254         std::vector<NoteResizeData *> _resize_data;
 255 };
 256
 257 #endif /* __gtk_ardour_midi_region_view_h__ */