position+width panning improvements (reverse width now works); relabel pan automation...
[ardour.git] / libs / ardour / ardour / midi_model.h
index a2e227515707f0bf941f96909b5a9de92470fc30..e959535a36798f90c9aedfffe2d6806f370d0e0e 100644 (file)
 
 */
 
-#ifndef __ardour_midi_model_h__ 
+#ifndef __ardour_midi_model_h__
 #define __ardour_midi_model_h__
 
+#include <queue>
+#include <deque>
+#include <utility>
 #include <boost/utility.hpp>
-#include <pbd/command.h>
-#include <ardour/types.h>
-#include <ardour/midi_buffer.h>
-#include <ardour/midi_ring_buffer.h>
+#include <glibmm/thread.h>
+#include "pbd/command.h"
+#include "ardour/types.h"
+#include "ardour/midi_buffer.h"
+#include "ardour/midi_ring_buffer.h"
+#include "ardour/automatable_sequence.h"
+#include "ardour/types.h"
+#include "evoral/Note.hpp"
+#include "evoral/Sequence.hpp"
 
 namespace ARDOUR {
 
 class Session;
-
-
-/** This is a slightly higher level (than MidiBuffer) model of MIDI note data.
- * Currently it only represents note data, which is represented as complete
- * note events (ie with a start time and a duration) rather than separate
- * note on and off events (controller data is not here since it's represented
- * as an AutomationList)
+class MidiSource;
+
+/** This is a higher level (than MidiBuffer) model of MIDI data, with separate
+ * representations for notes (instead of just unassociated note on/off events)
+ * and controller data.  Controller data is represented as part of the
+ * Automatable base (i.e. in a map of AutomationList, keyed by Parameter).
+ * Because of this MIDI controllers and automatable controllers/widgets/etc
+ * are easily interchangeable.
  */
-class MidiModel : public boost::noncopyable {
+class MidiModel : public AutomatableSequence<Evoral::MusicalTime> {
 public:
-       struct Note {
-               Note(double time=0, double dur=0, uint8_t note=0, uint8_t vel=0x40);
-               Note(const Note& copy);
+       typedef Evoral::MusicalTime TimeType;
 
-               inline bool operator==(const Note& other)
-                       { return time() == other.time() && note() == other.note(); }
+       MidiModel(MidiSource* s);
 
-               inline double  time()     const { return _on_event.time; }
-               inline double  end_time() const { return _off_event.time; }
-               inline uint8_t note()     const { return _on_event.note(); }
-               inline uint8_t velocity() const { return _on_event.velocity(); }
-               inline double  duration() const { return _off_event.time - _on_event.time; }
+       NoteMode note_mode() const { return (percussive() ? Percussive : Sustained); }
+       void set_note_mode(NoteMode mode) { set_percussive(mode == Percussive); };
 
-               inline void set_duration(double d) { _off_event.time = _on_event.time + d; }
+       class DiffCommand : public Command {
+       public:
+               enum Property {
+                       NoteNumber,
+                       Velocity,
+                       StartTime,
+                       Length,
+                       Channel
+               };
 
-               inline MidiEvent& on_event()  { return _on_event; }
-               inline MidiEvent& off_event() { return _off_event; }
-       
-               inline const MidiEvent& on_event()  const { return _on_event; }
-               inline const MidiEvent& off_event() const { return _off_event; }
-
-       private:
-               MidiEvent _on_event;
-               MidiEvent _off_event;
-               Byte      _on_event_buffer[3];
-               Byte      _off_event_buffer[3];
-       };
+               DiffCommand (boost::shared_ptr<MidiModel> m, const std::string& name);
+               DiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node);
 
-       MidiModel(Session& s, size_t size=0);
+               const std::string& name() const { return _name; }
 
-       void clear() { _notes.clear(); }
+               void operator()();
+               void undo();
 
-       NoteMode note_mode() const            { return _note_mode; }
-       void     set_note_mode(NoteMode mode) { _note_mode = mode; }
+               int set_state (const XMLNode&, int version);
+               XMLNode& get_state ();
 
-       void start_write();
-       bool currently_writing() const { return _writing; }
-       void end_write(bool delete_stuck=false);
+               void add (const NotePtr note);
+               void remove (const NotePtr note);
+                void side_effect_remove (const NotePtr note);
 
-       size_t read (MidiRingBuffer& dst, nframes_t start, nframes_t nframes, nframes_t stamp_offset) const;
+               void change (const NotePtr note, Property prop, uint8_t new_value);
+               void change (const NotePtr note, Property prop, TimeType new_time);
 
-       /** Resizes vector if necessary (NOT realtime safe) */
-       void append(const MidiBuffer& data);
-       
-       /** Resizes vector if necessary (NOT realtime safe) */
-       void append(double time, size_t size, const Byte* in_buffer);
-       
-       inline const Note& note_at(unsigned i) const { return _notes[i]; }
+                bool adds_or_removes() const { 
+                        return !_added_notes.empty() || !_removed_notes.empty();
+                }
 
-       inline size_t n_notes() const { return _notes.size(); }
+                DiffCommand& operator+= (const DiffCommand& other);
+                boost::shared_ptr<MidiModel> model() const { return _model; }
 
-       typedef std::vector<Note> Notes;
-       
-       inline static bool note_time_comparator (const Note& a, const Note& b) { 
-               return a.time() < b.time();
-       }
-
-       struct LaterNoteEndComparator {
-               typedef const Note* value_type;
-               inline bool operator()(const Note* const a, const Note* const b) { 
-                       return a->end_time() > b->end_time();
-               }
+          private:
+               boost::shared_ptr<MidiModel> _model;
+               const std::string            _name;
+
+               struct NoteChange {
+                       DiffCommand::Property property;
+                       NotePtr note;
+                       union {
+                               uint8_t  old_value;
+                               TimeType old_time;
+                       };
+                       union {
+                               uint8_t  new_value;
+                               TimeType new_time;
+                       };
+               };
+
+               typedef std::list<NoteChange> ChangeList;
+               ChangeList _changes;
+
+               typedef std::list< boost::shared_ptr< Evoral::Note<TimeType> > > NoteList;
+               NoteList _added_notes;
+               NoteList _removed_notes;
+
+                std::set<NotePtr> side_effect_removals;
+
+               XMLNode &marshal_change(const NoteChange&);
+               NoteChange unmarshal_change(XMLNode *xml_note);
+
+               XMLNode &marshal_note(const NotePtr note);
+               NotePtr unmarshal_note(XMLNode *xml_note);
        };
 
-       inline       Notes& notes()       { return _notes; }
-       inline const Notes& notes() const { return _notes; }
+       MidiModel::DiffCommand*  new_diff_command(const std::string name="midi edit");
+       void                     apply_command(Session& session, Command* cmd);
+       void                     apply_command_as_subcommand(Session& session, Command* cmd);
 
-       void     begin_command();
-       Command* current_command() { return _command; }
-       void     finish_command();
+       bool sync_to_source ();
+       bool write_to(boost::shared_ptr<MidiSource> source);
+       bool write_section_to (boost::shared_ptr<MidiSource> source, Evoral::MusicalTime begin = Evoral::MinMusicalTime,
+                               Evoral::MusicalTime end = Evoral::MaxMusicalTime);
 
-       // Commands
-       void add_note(const Note& note);
-       void remove_note(const Note& note);
+       // MidiModel doesn't use the normal AutomationList serialisation code
+       // since controller data is stored in the .mid
+       XMLNode& get_state();
+       int set_state(const XMLNode&) { return 0; }
 
-       sigc::signal<void> ContentsChanged;
-       
-private:
-       class MidiEditCommand : public Command
-       {
-       public:
-               MidiEditCommand (MidiModel& m) : _model(m) {}
-               //MidiEditCommand (MidiModel&, const XMLNode& node);
-               
-               void operator()();
-               void undo();
-               
-               /*int set_state (const XMLNode&);
-               XMLNode& get_state ();*/
+       PBD::Signal0<void> ContentsChanged;
+
+       const MidiSource* midi_source() const { return _midi_source; }
+       void set_midi_source (MidiSource *);
 
-               void add_note(const Note& note);
-               void remove_note(const Note& note);
+       boost::shared_ptr<Evoral::Note<TimeType> > find_note (NotePtr);
+       boost::shared_ptr<Evoral::Note<TimeType> > find_note (gint note_id);
 
-       private:
-               MidiModel&      _model;
-               std::list<Note> _added_notes;
-               std::list<Note> _removed_notes;
+        InsertMergePolicy insert_merge_policy () const;
+        void set_insert_merge_policy (InsertMergePolicy);
+
+       boost::shared_ptr<Evoral::Control> control_factory(const Evoral::Parameter& id);
+
+protected:
+        int resolve_overlaps_unlocked (const NotePtr, void* arg = 0);
+
+private:
+       struct WriteLockImpl : public AutomatableSequence<TimeType>::WriteLockImpl {
+               WriteLockImpl(Glib::Mutex::Lock* source_lock, Glib::RWLock& s, Glib::Mutex& c)
+                       : AutomatableSequence<TimeType>::WriteLockImpl(s, c)
+                       , source_lock(source_lock)
+               {}
+               ~WriteLockImpl() {
+                       delete source_lock;
+               }
+               Glib::Mutex::Lock* source_lock;
        };
 
-       void append_note_on(double time, uint8_t note, uint8_t velocity);
-       void append_note_off(double time, uint8_t note);
+public:
+       virtual WriteLock edit_lock();
+       virtual WriteLock write_lock();
 
-       Session& _session;
+private:
+       friend class DeltaCommand;
 
-       Notes    _notes;
-       NoteMode _note_mode;
+       void source_interpolation_changed (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
+       void source_automation_state_changed (Evoral::Parameter, AutoState);
+       void control_list_interpolation_changed (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
+       void automation_list_automation_state_changed (Evoral::Parameter, AutoState);
        
-       typedef std::vector<size_t> WriteNotes;
-       WriteNotes _write_notes;
-       bool       _writing;
+       PBD::ScopedConnectionList _midi_source_connections;
 
-       MidiEditCommand* _command; ///< In-progress command
+       // We cannot use a boost::shared_ptr here to avoid a retain cycle
+       MidiSource* _midi_source;
+        InsertMergePolicy _insert_merge_policy;
 };
 
 } /* namespace ARDOUR */