switch Route::fed_by from shared_ptr to weak_ptr and thus begin to allow Route destru...
[ardour.git] / libs / ardour / ardour / midi_model.h
index 98e159002a35c63b72453378e40a27a44f882a85..b099f575a16b3e6b761c705c2830542d0d4fd144 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-#ifndef __ardour_midi_model_h__ 
+#ifndef __ardour_midi_model_h__
 #define __ardour_midi_model_h__
 
 #include <queue>
 #include <utility>
 #include <boost/utility.hpp>
 #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.h>
-#include <ardour/note.h>
-#include <ardour/types.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;
 class MidiSource;
-       
-/**
- * This class keeps track of the current x and y for a control
- */
-class MidiControlIterator {
-public:
-       boost::shared_ptr<const AutomationList> automation_list;
-       double x;
-       double y;
-       
-       MidiControlIterator(boost::shared_ptr<const AutomationList> a_list,
-                       double a_x,
-                       double a_y)
-               : automation_list(a_list)
-               , x(a_x)
-               , y(a_y)
-       {}
-};
-
 
 /** 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, public Automatable {
+class MidiModel : public AutomatableSequence<Evoral::MusicalTime> {
 public:
+       typedef double TimeType;
+
        MidiModel(MidiSource* s, size_t size=0);
-       
-       void write_lock();
-       void write_unlock();
 
-       void read_lock()   const;
-       void read_unlock() const;
+       NoteMode note_mode() const { return (percussive() ? Percussive : Sustained); }
+       void set_note_mode(NoteMode mode) { set_percussive(mode == Percussive); };
 
-       void clear();
+       /** Add/Remove notes.
+        * Technically all note operations can be implemented as one of these, but
+        * a custom command can be more efficient.
+        */
+       class DeltaCommand : public Command {
+       public:
+               DeltaCommand (boost::shared_ptr<MidiModel> m, const std::string& name);
+               DeltaCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node);
 
-       NoteMode note_mode() const            { return _note_mode; }
-       void     set_note_mode(NoteMode mode) { _note_mode = mode; }
+               const std::string& name() const { return _name; }
 
-       void start_write();
-       bool writing() const { return _writing; }
-       void end_write(bool delete_stuck=false);
+               void operator()();
+               void undo();
 
-       size_t read (MidiRingBuffer& dst, nframes_t start, nframes_t nframes, nframes_t stamp_offset, nframes_t negative_stamp_offset) const;
+               int set_state (const XMLNode&, int version);
+               XMLNode& get_state ();
 
-       /** Resizes vector if necessary (NOT realtime safe) */
-       void append(const MIDI::Event& ev);
-       
-       inline const boost::shared_ptr<const Note> note_at(unsigned i) const { return _notes[i]; }
-       inline const boost::shared_ptr<Note>       note_at(unsigned i)       { return _notes[i]; }
+               void add(const boost::shared_ptr< Evoral::Note<TimeType> > note);
+               void remove(const boost::shared_ptr< Evoral::Note<TimeType> > note);
 
-       inline size_t n_notes() const { return _notes.size(); }
-       inline bool   empty()   const { return _notes.size() == 0 && _controls.size() == 0; }
+       private:
+               XMLNode &marshal_note(const boost::shared_ptr< Evoral::Note<TimeType> > note);
+               boost::shared_ptr< Evoral::Note<TimeType> > unmarshal_note(XMLNode *xml_note);
 
-       inline static bool note_time_comparator (const boost::shared_ptr<const Note> a,
-                                                const boost::shared_ptr<const Note> b) { 
-               return a->time() < b->time();
-       }
+               boost::shared_ptr<MidiModel> _model;
+               const std::string            _name;
 
-       struct LaterNoteEndComparator {
-               typedef const Note* value_type;
-               inline bool operator()(const boost::shared_ptr<const Note> a,
-                                      const boost::shared_ptr<const Note> b) const { 
-                       return a->end_time() > b->end_time();
-               }
+               typedef std::list< boost::shared_ptr< Evoral::Note<TimeType> > > NoteList;
+
+               NoteList _added_notes;
+               NoteList _removed_notes;
        };
 
-       typedef std::vector< boost::shared_ptr<Note> > Notes;
-       inline       Notes& notes()       { return _notes; }
-       inline const Notes& notes() const { return _notes; }
 
-       /** Add/Remove notes.
-        * Technically all operations can be implemented as one of these.
+       /** Change note properties.
+        * More efficient than DeltaCommand and has the important property that
+        * it leaves the objects in the MidiModel (Notes) the same, thus
+        * enabling selection and other state to persist across command
+        * do/undo/redo.
         */
-       class DeltaCommand : public Command
-       {
+       class DiffCommand : public Command {
        public:
-               DeltaCommand (boost::shared_ptr<MidiModel> m, const std::string& name);
-               DeltaCommand (boost::shared_ptr<MidiModel>,   const XMLNode& node);
+               enum Property {
+                       NoteNumber,
+                       Velocity,
+                       StartTime,
+                       Length,
+                       Channel
+               };
+
+               DiffCommand (boost::shared_ptr<MidiModel> m, const std::string& name);
+               DiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node);
 
                const std::string& name() const { return _name; }
-               
+
                void operator()();
                void undo();
-               
-               int set_state (const XMLNode&);
+
+               int set_state (const XMLNode&, int version);
                XMLNode& get_state ();
 
-               void add(const boost::shared_ptr<Note> note);
-               void remove(const boost::shared_ptr<Note> note);
+               void change (const boost::shared_ptr<Evoral::Note<TimeType> > note,
+                               Property prop, uint8_t new_value);
+               void change (const boost::shared_ptr<Evoral::Note<TimeType> > note,
+                               Property prop, TimeType new_time);
 
        private:
-               XMLNode &marshal_note(const boost::shared_ptr<Note> note);
-               boost::shared_ptr<Note> unmarshal_note(XMLNode *xml_note);
-               
-               boost::shared_ptr<MidiModel>         _model;
-               const std::string                    _name;
-               
-               typedef std::list< boost::shared_ptr<Note> > NoteList;
-               
-               NoteList _added_notes;
-               NoteList _removed_notes;
+               boost::shared_ptr<MidiModel> _model;
+               const std::string            _name;
+
+               struct NotePropertyChange {
+                       DiffCommand::Property property;
+                       boost::shared_ptr< Evoral::Note<TimeType> > note;
+                       union {
+                               uint8_t  old_value;
+                               TimeType old_time;
+                       };
+                       union {
+                               uint8_t  new_value;
+                               TimeType new_time;
+                       };
+               };
+
+               typedef std::list<NotePropertyChange> ChangeList;
+               ChangeList _changes;
+
+               XMLNode &marshal_change(const NotePropertyChange&);
+               NotePropertyChange unmarshal_change(XMLNode *xml_note);
        };
 
        MidiModel::DeltaCommand* new_delta_command(const std::string name="midi edit");
-       void                     apply_command(Command* cmd);
+       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);
 
-       bool edited() const { return _edited; }
-       void set_edited(bool yn) { _edited = yn; }
        bool write_to(boost::shared_ptr<MidiSource> source);
-               
+
        // 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;
-       
-       /** Read iterator */
-       class const_iterator {
-       public:
-               const_iterator(const MidiModel& model, double t);
-               ~const_iterator();
-
-               inline bool locked() const { return _locked; }
 
-               const MIDI::Event& operator*()  const { return *_event;  }
-               const boost::shared_ptr<MIDI::Event> operator->() const  { return _event; }
-               const boost::shared_ptr<MIDI::Event> get_event_pointer() { return _event; }
+       const MidiSource* midi_source() const { return _midi_source; }
+       void set_midi_source(MidiSource* source) { _midi_source = source; }
 
-               const const_iterator& operator++(); // prefix only
-               bool operator==(const const_iterator& other) const;
-               bool operator!=(const const_iterator& other) const { return ! operator==(other); }
-               
-               const_iterator& operator=(const const_iterator& other);
+       boost::shared_ptr<Evoral::Note<TimeType> > find_note (boost::shared_ptr<Evoral::Note<TimeType> >);
 
-       private:
-               friend class MidiModel;
-
-               const MidiModel*               _model;
-               boost::shared_ptr<MIDI::Event> _event;
-
-               typedef std::priority_queue<
-                               boost::shared_ptr<Note>, std::deque< boost::shared_ptr<Note> >,
-                               LaterNoteEndComparator>
-                       ActiveNotes;
-               
-               mutable ActiveNotes _active_notes;
-
-               bool                                       _is_end;
-               bool                                       _locked;
-               Notes::const_iterator                      _note_iter;
-               std::vector<MidiControlIterator>           _control_iters;
-               std::vector<MidiControlIterator>::iterator _control_iter;
+private:
+       struct WriteLockImpl : public AutomatableSequence<Evoral::MusicalTime>::WriteLockImpl {
+               WriteLockImpl(Glib::Mutex::Lock* source_lock, Glib::RWLock& s, Glib::Mutex& c)
+                       : AutomatableSequence<Evoral::MusicalTime>::WriteLockImpl(s, c)
+                       , source_lock(source_lock)
+               {}
+               ~WriteLockImpl() {
+                       delete source_lock;
+               }
+               Glib::Mutex::Lock* source_lock;
        };
-       
-       const_iterator        begin() const { return const_iterator(*this, 0); }
-       const const_iterator& end()   const { return _end_iter; }
-       
-       const MidiSource* midi_source() const { return _midi_source; }
-       void set_midi_source(MidiSource* source) { _midi_source = source; } 
-       boost::shared_ptr<MIDI::Event> control_to_midi_event(const MidiControlIterator& iter) const;
-       
+
+public:
+       virtual WriteLock edit_lock();
+       virtual WriteLock write_lock();
+
 private:
        friend class DeltaCommand;
-       void add_note_unlocked(const boost::shared_ptr<Note> note);
-       void remove_note_unlocked(const boost::shared_ptr<const Note> note);
-
-       friend class const_iterator;
-
-#ifndef NDEBUG
-       bool is_sorted() const;
-#endif
-
-       void append_note_on_unlocked(uint8_t chan, double time, uint8_t note, uint8_t velocity);
-       void append_note_off_unlocked(uint8_t chan, double time, uint8_t note);
-       void append_automation_event_unlocked(AutomationType type, uint8_t chan, double time, uint8_t first_byte, uint8_t second_byte);
-       void append_pgm_change_unlocked(uint8_t chan, double time, uint8_t number); 
-
-       mutable Glib::RWLock _lock;
-
-       Notes _notes;
-       
-       NoteMode _note_mode;
-       
-       typedef std::vector<size_t> WriteNotes;
-       WriteNotes _write_notes[16];
-       bool       _writing;
-       bool       _edited;
-       
-       typedef std::vector< boost::shared_ptr<const ARDOUR::AutomationList> > AutomationLists;
-       AutomationLists _dirty_automations;
-
-       const const_iterator _end_iter;
-
-       mutable nframes_t      _next_read;
-       mutable const_iterator _read_iter;
-
-       typedef std::priority_queue<
-                       boost::shared_ptr<Note>, std::deque< boost::shared_ptr<Note> >,
-                       LaterNoteEndComparator>
-               ActiveNotes;
-       
+
        // We cannot use a boost::shared_ptr here to avoid a retain cycle
        MidiSource* _midi_source;
 };