*/
-#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 <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 "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;
-
-// x , y
-typedef std::pair<boost::shared_ptr<const AutomationList>, std::pair<double,double> >
- MidiControlIterator;
-
-/** 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)
+/** 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:
- MidiModel(Session& s, size_t size=0);
-
- // This is crap.
- void write_lock() { _lock.writer_lock(); _automation_lock.lock(); }
- void write_unlock() { _lock.writer_unlock(); _automation_lock.unlock(); }
- void read_lock() const { _lock.reader_lock(); /*_automation_lock.lock();*/ }
- void read_unlock() const { _lock.reader_unlock(); /*_automation_lock.unlock();*/ }
-
- void clear() { _notes.clear(); }
-
- NoteMode note_mode() const { return _note_mode; }
- void set_note_mode(NoteMode mode) { _note_mode = mode; }
-
- void start_write();
- bool writing() const { return _writing; }
- void end_write(bool delete_stuck=false);
-
- size_t read (MidiRingBuffer& dst, nframes_t start, nframes_t nframes, nframes_t stamp_offset) const;
-
- /** Resizes vector if necessary (NOT realtime safe) */
- void append(const MidiBuffer& data);
-
- /** Resizes vector if necessary (NOT realtime safe) */
- void append(const MidiEvent& ev);
-
- inline const Note& note_at(unsigned i) const { return _notes[i]; }
-
- inline size_t n_notes() const { return _notes.size(); }
- inline bool empty() const { return _notes.size() == 0 && _controls.size() == 0; }
-
- 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();
- }
- };
+ typedef double TimeType;
+
+ MidiModel(MidiSource* s);
+
+ NoteMode note_mode() const { return (percussive() ? Percussive : Sustained); }
+ void set_note_mode(NoteMode mode) { set_percussive(mode == Percussive); };
- 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.
+ * Technically all note operations can be implemented as one of these, but
+ * a custom command can be more efficient.
*/
- class DeltaCommand : public Command
- {
+ class DeltaCommand : public Command {
public:
- DeltaCommand (MidiModel& m, const std::string& name)
- : Command(name), _model(m), _name(name) {}
- //DeltaCommand (MidiModel&, const XMLNode& node);
+ DeltaCommand (boost::shared_ptr<MidiModel> m, const std::string& name);
+ DeltaCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node);
const std::string& name() const { return _name; }
-
+
void operator()();
void undo();
-
- /*int set_state (const XMLNode&);
- XMLNode& get_state ();*/
- void add(const Note& note);
- void remove(const Note& note);
+ int set_state (const XMLNode&, int version);
+ XMLNode& get_state ();
+
+ void add(const boost::shared_ptr< Evoral::Note<TimeType> > note);
+ void remove(const boost::shared_ptr< Evoral::Note<TimeType> > note);
private:
- MidiModel& _model;
- std::string _name;
- std::list<Note> _added_notes;
- std::list<Note> _removed_notes;
- };
+ XMLNode &marshal_note(const boost::shared_ptr< Evoral::Note<TimeType> > note);
+ boost::shared_ptr< Evoral::Note<TimeType> > unmarshal_note(XMLNode *xml_note);
- MidiModel::DeltaCommand* new_delta_command(const std::string name="midi edit");
- void apply_command(Command* cmd);
+ boost::shared_ptr<MidiModel> _model;
+ const std::string _name;
- 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, as CC data is in the .mid
- XMLNode& get_state();
- int set_state(const XMLNode&) { return 0; }
+ typedef std::list< boost::shared_ptr< Evoral::Note<TimeType> > > NoteList;
+
+ NoteList _added_notes;
+ NoteList _removed_notes;
+ };
- sigc::signal<void> ContentsChanged;
-
- /** Read iterator */
- class const_iterator {
+
+ /** 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 DiffCommand : public Command {
public:
- const_iterator(const MidiModel& model, double t);
- ~const_iterator();
+ enum Property {
+ NoteNumber,
+ Velocity,
+ StartTime,
+ Length,
+ Channel
+ };
- const MidiEvent& operator*() const { return _event; }
- const MidiEvent* operator->() const { return &_event; }
+ DiffCommand (boost::shared_ptr<MidiModel> m, const std::string& name);
+ DiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node);
- const const_iterator& operator++(); // prefix only
- bool operator==(const const_iterator& other) const;
- bool operator!=(const const_iterator& other) const { return ! operator==(other); }
+ const std::string& name() const { return _name; }
+
+ void operator()();
+ void undo();
+
+ int set_state (const XMLNode&, int version);
+ XMLNode& get_state ();
+
+ 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:
- const MidiModel* _model;
- MidiEvent _event;
-
- typedef std::priority_queue<const Note*,std::vector<const 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;
+ boost::shared_ptr<MidiModel> _model;
+ const std::string _name;
+
+ struct NoteChange {
+ 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<NoteChange> ChangeList;
+ ChangeList _changes;
+
+ XMLNode &marshal_change(const NoteChange&);
+ NoteChange unmarshal_change(XMLNode *xml_note);
};
-
- const_iterator begin() const { return const_iterator(*this, 0); }
- const const_iterator& end() const { return _end_iter; }
-
-private:
- friend class DeltaCommand;
- void add_note_unlocked(const Note& note);
- void remove_note_unlocked(const Note& note);
- friend class const_iterator;
- bool control_to_midi_event(MidiEvent& ev, const MidiControlIterator& iter) const;
+ MidiModel::DeltaCommand* new_delta_command(const std::string name="midi edit");
+ 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);
-#ifndef NDEBUG
- bool is_sorted() const;
-#endif
+ 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);
- void append_note_on_unlocked(double time, uint8_t note, uint8_t velocity);
- void append_note_off_unlocked(double time, uint8_t note);
- void append_cc_unlocked(double time, uint8_t number, uint8_t value);
+ // 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; }
+
+ PBD::Signal0<void> ContentsChanged;
- mutable Glib::RWLock _lock;
+ const MidiSource* midi_source() const { return _midi_source; }
+ void set_midi_source(MidiSource* source) { _midi_source = source; }
- Notes _notes;
- NoteMode _note_mode;
-
- typedef std::vector<size_t> WriteNotes;
- WriteNotes _write_notes;
- bool _writing;
- bool _edited;
+ boost::shared_ptr<Evoral::Note<TimeType> > find_note (boost::shared_ptr<Evoral::Note<TimeType> >);
- const const_iterator _end_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;
+ };
- mutable nframes_t _next_read;
- mutable const_iterator _read_iter;
+public:
+ virtual WriteLock edit_lock();
+ virtual WriteLock write_lock();
- // note state for read():
- // (TODO: Remove and replace with iterator)
-
- typedef std::priority_queue<const Note*,std::vector<const Note*>,
- LaterNoteEndComparator> ActiveNotes;
+private:
+ friend class DeltaCommand;
- //mutable ActiveNotes _active_notes;
+ // We cannot use a boost::shared_ptr here to avoid a retain cycle
+ MidiSource* _midi_source;
};
} /* namespace ARDOUR */
projects / ardour.git / blobdiff