Move control surface options into RC prefs editor. Remove Options menu.
[ardour.git] / gtk2_ardour / midi_region_view.h
index 6ee2210867c3cd48d0c18d86e2a3bf655c22d969..b26edb5a47c81c459837e6b92eda70810331e6a9 100644 (file)
 #ifndef __gtk_ardour_midi_region_view_h__
 #define __gtk_ardour_midi_region_view_h__
 
+#include <string>
 #include <vector>
 
 #include <libgnomecanvasmm.h>
 #include <libgnomecanvasmm/polygon.h>
-#include <ardour/midi_track.h>
-#include <ardour/midi_region.h>
-#include <ardour/midi_model.h>
-#include <ardour/diskstream.h>
-#include <ardour/types.h>
+#include "ardour/midi_track.h"
+#include "ardour/midi_region.h"
+#include "ardour/midi_model.h"
+#include "ardour/diskstream.h"
+#include "ardour/types.h"
 
 #include "region_view.h"
 #include "midi_time_axis.h"
@@ -38,6 +39,7 @@
 #include "canvas-note.h"
 #include "canvas-note-event.h"
 #include "canvas-program-change.h"
+#include "canvas-sysex.h"
 
 namespace ARDOUR {
        class MidiRegion;
@@ -58,6 +60,8 @@ class AutomationRegionView;
 class MidiRegionView : public RegionView
 {
   public:
+       typedef Evoral::Note<ARDOUR::MidiModel::TimeType> NoteType;
+
        MidiRegionView (ArdourCanvas::Group *,
                        RouteTimeAxisView&,
                        boost::shared_ptr<ARDOUR::MidiRegion>,
@@ -83,37 +87,31 @@ class MidiRegionView : public RegionView
        void set_height (double);
        void apply_note_range(uint8_t lowest, uint8_t highest, bool force=false);
 
+       inline ARDOUR::ColorMode color_mode() const { return midi_view()->color_mode(); }
+       
        void set_frame_color();
 
        void redisplay_model();
 
        GhostRegion* add_ghost (TimeAxisView&);
 
-       void add_note(const boost::shared_ptr<Evoral::Note> note);
+       void add_note(const boost::shared_ptr<NoteType> note);
        void resolve_note(uint8_t note_num, double end_time);
        
-       struct ControlEvent
-       {
-               nframes_t time;
-               uint8_t   value;
-               uint8_t   channel;
-               
-               ControlEvent(nframes_t a_time, uint8_t a_value, uint8_t a_channel) 
+       struct PCEvent {
+               PCEvent(double a_time, uint8_t a_value, uint8_t a_channel) 
                        : time(a_time), value(a_value), channel(a_channel) {}
-               
-               ControlEvent& operator=(const ControlEvent& other) {
-                       time = other.time;
-                       value = other.value;
-                       channel = other.channel;
-                       return *this;
-               }
+
+               double  time;
+               uint8_t value;
+               uint8_t channel;
        };
        
        /** Add a new program change flag to the canvas.
-        * @param program the MidiRegionView::ControlEvent to add
+        * @param program the MidiRegionView::PCEvent to add
         * @param the text to display in the flag
         */
-       void add_pgm_change(ControlEvent& program, string displaytext);
+       void add_pgm_change(PCEvent& program, const std::string& displaytext);
        
        /** Look up the given time and channel in the 'automation' and set keys accordingly.
         * @param time the time of the program change event
@@ -124,10 +122,10 @@ class MidiRegionView : public RegionView
        void get_patch_key_at(double time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key);
        
        /** Change the 'automation' data of old_program to new values which correspond to new_patch.
-        * @param old_program identifies the program change event which is to be altered
-        * @param new_patch defines the new lsb, msb and program number which are to be set in the automation list data
+        * @param old_program the program change event which is to be altered
+        * @param new_patch the new lsb, msb and program number which are to be set
         */
-       void alter_program_change(ControlEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
+       void alter_program_change(PCEvent& old_program, const MIDI::Name::PatchPrimaryKey& new_patch);
        
        /** Alter a given program to the new given one.
         * (Called on context menu select on CanvasProgramChange)
@@ -144,20 +142,24 @@ class MidiRegionView : public RegionView
         */
        void next_program(ArdourCanvas::CanvasProgramChange& program);
        
-       /** Displays all program changed events in the region as flags on the canvas.
+       /** Displays all program change events in the region as flags on the canvas.
+        */
+       void display_program_changes();
+       
+       /** Displays all system exclusive events in the region as flags on the canvas.
         */
-       void find_and_insert_program_change_flags();
+       void display_sysexes();
 
        void begin_write();
        void end_write();
        void extend_active_notes();
 
-       void create_note_at(double x, double y, double duration);
+       void create_note_at(double x, double y, double length);
 
        void display_model(boost::shared_ptr<ARDOUR::MidiModel> model);
 
-       void start_delta_command(string name = "midi edit");
-       void command_add_note(const boost::shared_ptr<Evoral::Note> note, bool selected);
+       void start_delta_command(std::string name = "midi edit");
+       void command_add_note(const boost::shared_ptr<NoteType> note, bool selected, bool show_velocity=false);
        void command_remove_note(ArdourCanvas::CanvasNoteEvent* ev);
 
        void apply_command();
@@ -171,19 +173,19 @@ class MidiRegionView : public RegionView
        size_t selection_size() { return _selection.size(); }
 
        void move_selection(double dx, double dy);
-       void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double dt, uint8_t dnote);
+       void note_dropped(ArdourCanvas::CanvasNoteEvent* ev, double d_pixels, uint8_t d_note);
 
-       /** Get the region position in pixels.
-        * This function is needed to subtract the region start in pixels
-        * from world coordinates submitted by the mouse
-        */
+       /** Return true iff the note is within the currently visible range */
+       bool note_in_visible_range(const boost::shared_ptr<NoteType> note) const;
+
+       /** Get the region position in pixels relative to session. */
        double get_position_pixels();
 
        /** Begin resizing of some notes.
         * Called by CanvasMidiNote when resizing starts.
         * @param note_end which end of the note, NOTE_ON or NOTE_OFF
         */
-       void  begin_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end);
+       void begin_resizing(ArdourCanvas::CanvasNote::NoteEnd note_end);
 
        /** Update resizing notes while user drags.
         * @param note_end which end of the note, NOTE_ON or NOTE_OFF
@@ -211,7 +213,14 @@ class MidiRegionView : public RegionView
         */
        void change_channel(uint8_t channel);
 
-       enum MouseState { None, Pressed, SelectTouchDragging, SelectRectDragging, AddDragging, EraseTouchDragging };
+       enum MouseState {
+               None,
+               Pressed,
+               SelectTouchDragging,
+               SelectRectDragging,
+               AddDragging
+       };
+
        MouseState mouse_state() const { return _mouse_state; }
 
        struct NoteResizeData {
@@ -221,7 +230,6 @@ class MidiRegionView : public RegionView
        };
        
        /** Snap a region relative pixel coordinate to pixel units.
-        * for pixel units (double) instead of nframes64_t
         * @param x a pixel coordinate relative to region start
         * @return the snapped pixel coordinate relative to region start
         */
@@ -231,16 +239,21 @@ class MidiRegionView : public RegionView
         * @param x a pixel coordinate relative to region start
         * @return the snapped nframes64_t coordinate relative to region start
         */
-       nframes64_t snap_to_frame(double x);
+       nframes64_t snap_pixel_to_frame(double x);
 
        /** Snap a region relative frame coordinate to frame units.
         * @param x a pixel coordinate relative to region start
         * @return the snapped nframes64_t coordinate relative to region start
         */
-       nframes64_t snap_to_frame(nframes64_t x);
+       nframes64_t snap_frame_to_frame(nframes64_t x);
+       
+       /** Convert a timestamp in beats to frames (both relative to region start) */
+       nframes64_t beats_to_frames(double beats) const;
+       
+       /** Convert a timestamp in frames to beats (both relative to region start) */
+       double frames_to_beats(nframes64_t beats) const;
        
   protected:
-
     /** Allows derived types to specify their visibility requirements
      * to the TimeAxisViewItem parent class.
      */
@@ -259,6 +272,15 @@ class MidiRegionView : public RegionView
        void reset_width_dependent_items (double pixel_width);
 
   private:
+       /** Play the NoteOn event of the given note immediately
+        * and schedule the playback of the corresponding NoteOff event.
+        */
+       void play_midi_note(boost::shared_ptr<NoteType> note);
+       
+       /** Play the NoteOff-Event of the given note immediately
+        * (scheduled by @ref play_midi_note()).
+        */
+       bool play_midi_note_off(boost::shared_ptr<NoteType> note);
 
        void clear_events();
        void switch_source(boost::shared_ptr<ARDOUR::Source> src);
@@ -269,7 +291,7 @@ class MidiRegionView : public RegionView
        void midi_channel_mode_changed(ARDOUR::ChannelMode mode, uint16_t mask);
        void midi_patch_settings_changed(std::string model, std::string custom_device_mode);
        
-       void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t velocity, bool relative=false);
+       void change_note_velocity(ArdourCanvas::CanvasNoteEvent* ev, int8_t vel, bool relative=false);
 
        void clear_selection_except(ArdourCanvas::CanvasNoteEvent* ev);
        void clear_selection() { clear_selection_except(NULL); }
@@ -281,15 +303,20 @@ class MidiRegionView : public RegionView
        uint8_t  _current_range_min;
        uint8_t  _current_range_max;
        
-       string   _model_name;
-       string   _custom_device_mode;   
+       /// MIDNAM information of the current track: Model name of MIDNAM file
+       std::string _model_name;
+       
+       /// MIDNAM information of the current track: CustomDeviceMode
+       std::string _custom_device_mode;   
 
        typedef std::vector<ArdourCanvas::CanvasNoteEvent*> Events;
        typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasProgramChange> > PgmChanges;
+       typedef std::vector< boost::shared_ptr<ArdourCanvas::CanvasSysEx> > SysExes;
        
        boost::shared_ptr<ARDOUR::MidiModel> _model;
        Events                               _events;
        PgmChanges                           _pgm_changes;
+       SysExes                              _sys_exes;
        ArdourCanvas::CanvasNote**           _active_notes;
        ArdourCanvas::Group*                 _note_group;
        ARDOUR::MidiModel::DeltaCommand*     _delta_command;
@@ -303,7 +330,11 @@ class MidiRegionView : public RegionView
 
        /** New notes (created in the current command) which should be selected
         * when they appear after the command is applied. */
-       std::set< boost::shared_ptr<Evoral::Note> > _marked_for_selection;
+       std::set< boost::shared_ptr<NoteType> > _marked_for_selection;
+       
+       /** New notes (created in the current command) which should have visible velocity
+        * when they appear after the command is applied. */
+       std::set< boost::shared_ptr<NoteType> > _marked_for_velocity;
 
        std::vector<NoteResizeData *> _resize_data;
 };