/*
- Copyright (C) 2006 Paul Davis
- Author: Dave Robillard
+ Copyright (C) 2007 Paul Davis
+ Author: Dave Robillard
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
*/
-#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 <ardour/types.h>
-#include <ardour/midi_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 {
-/** A dynamically resizable collection of MIDI events, sorted by time
+class Session;
+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:
- MidiModel(size_t size=0);
- ~MidiModel();
+ typedef double TimeType;
+
+ 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); };
+
+ /** 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);
+
+ const std::string& name() const { return _name; }
+
+ void operator()();
+ void undo();
+
+ 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:
+ XMLNode &marshal_note(const boost::shared_ptr< Evoral::Note<TimeType> > note);
+ boost::shared_ptr< Evoral::Note<TimeType> > unmarshal_note(XMLNode *xml_note);
+
+ boost::shared_ptr<MidiModel> _model;
+ const std::string _name;
+
+ typedef std::list< boost::shared_ptr< Evoral::Note<TimeType> > > NoteList;
+
+ NoteList _added_notes;
+ NoteList _removed_notes;
+ };
+
+
+ /** 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:
+ 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 clear() { _events.clear(); }
+ void operator()();
+ void undo();
- /** 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, Byte* in_buffer);
-
- inline const MidiEvent& event_at(unsigned i) const { return _events[i]; }
+ int set_state (const XMLNode&, int version);
+ XMLNode& get_state ();
- inline size_t n_events() const { return _events.size(); }
+ 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:
+ 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");
+ 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 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;
+
+ 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:
- std::vector<MidiEvent> _events;
+ 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;
+
+ // We cannot use a boost::shared_ptr here to avoid a retain cycle
+ MidiSource* _midi_source;
};
} /* namespace ARDOUR */
projects / ardour.git / blobdiff