*/
-#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 "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 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:
- struct Note {
- Note(double time=0, double dur=0, uint8_t note=0, uint8_t vel=0x40);
- Note(const Note& copy);
-
- const MidiModel::Note& operator=(const MidiModel::Note& copy);
-
- inline bool operator==(const Note& other)
- { return time() == other.time() && note() == other.note(); }
-
- 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(); }
-
- inline void set_time(double t) { _off_event.time() = t + duration(); _on_event.time() = t; }
- inline void set_note(uint8_t n) { _on_event.buffer()[1] = n; _off_event.buffer()[1] = n; }
- inline void set_velocity(uint8_t n) { _on_event.buffer()[2] = n; }
- inline void set_duration(double d) { _off_event.time() = _on_event.time() + d; }
-
- 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; }
+ typedef double TimeType;
- private:
- // Event buffers are self-contained
- MidiEvent _on_event;
- MidiEvent _off_event;
- };
+ MidiModel(MidiSource* s, size_t size=0);
+
+ NoteMode note_mode() const { return (percussive() ? Percussive : Sustained); }
+ void set_note_mode(NoteMode mode) { set_percussive(mode == Percussive); };
- MidiModel(Session& s, size_t size=0);
+ /** 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);
- void clear() { _notes.clear(); }
+ const std::string& name() const { return _name; }
- NoteMode note_mode() const { return _note_mode; }
- void set_note_mode(NoteMode mode) { _note_mode = mode; }
+ void operator()();
+ void undo();
- void start_write();
- bool currently_writing() const { return _writing; }
- void end_write(bool delete_stuck=false);
+ int set_state (const XMLNode&, int version);
+ XMLNode& get_state ();
- size_t read (MidiRingBuffer& dst, nframes_t start, nframes_t nframes, nframes_t stamp_offset) const;
+ void add(const boost::shared_ptr< Evoral::Note<TimeType> > note);
+ void remove(const boost::shared_ptr< Evoral::Note<TimeType> > note);
- /** 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);
- void append(const MidiEvent& ev);
-
- inline const Note& note_at(unsigned i) const { return _notes[i]; }
+ private:
+ XMLNode &marshal_note(const boost::shared_ptr< Evoral::Note<TimeType> > note);
+ boost::shared_ptr< Evoral::Note<TimeType> > unmarshal_note(XMLNode *xml_note);
- inline size_t n_notes() const { return _notes.size(); }
- inline bool empty() const { return _notes.size() == 0 && _controls.size() == 0; }
+ boost::shared_ptr<MidiModel> _model;
+ const std::string _name;
- typedef std::vector<Note> Notes;
-
- inline static bool note_time_comparator (const Note& a, const Note& b) {
- return a.time() < b.time();
- }
+ typedef std::list< boost::shared_ptr< Evoral::Note<TimeType> > > NoteList;
- 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();
- }
+ NoteList _added_notes;
+ NoteList _removed_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 (MidiModel& m, const std::string& name)
- : Command(name), _model(m), _name(name) {}
- //DeltaCommand (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&);
- XMLNode& get_state ();*/
- void add(const Note& note);
- void remove(const Note& note);
+ 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:
- MidiModel& _model;
- std::string _name;
- std::list<Note> _added_notes;
- std::list<Note> _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, as CC data is in the .mid
+
+ // 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;
-
+
+ const MidiSource* midi_source() const { return _midi_source; }
+ void set_midi_source(MidiSource* source) { _midi_source = source; }
+
+ boost::shared_ptr<Evoral::Note<TimeType> > find_note (boost::shared_ptr<Evoral::Note<TimeType> >);
+
+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;
+ };
+
+public:
+ virtual WriteLock edit_lock();
+ virtual WriteLock write_lock();
+
private:
friend class DeltaCommand;
- void add_note_unlocked(const Note& note);
- void remove_note_unlocked(const Note& note);
-
-#ifndef NDEBUG
- bool is_sorted() const;
-#endif
-
- void append_note_on(double time, uint8_t note, uint8_t velocity);
- void append_note_off(double time, uint8_t note);
- void append_cc(double time, uint8_t number, uint8_t value);
-
- Glib::RWLock _lock;
-
- Notes _notes;
- NoteMode _note_mode;
-
- typedef std::vector<size_t> WriteNotes;
- WriteNotes _write_notes;
- bool _writing;
- bool _edited;
-
- // note state for read():
-
- typedef std::priority_queue<const Note*,std::vector<const Note*>,
- LaterNoteEndComparator> ActiveNotes;
-
- 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