/*
Copyright (C) 2007 Paul Davis
- Author: Dave Robillard
+ Author: David 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 <pbd/command.h>
-#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 {
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 {
+class MidiModel : public AutomatableSequence<Evoral::MusicalTime> {
public:
- struct Note {
- Note(double s=0, double d=0, uint8_t n=0, uint8_t v=0)
- : start(s), duration(d), note(n), velocity(v) {}
+ typedef Evoral::MusicalTime TimeType;
+
+ MidiModel (boost::shared_ptr<MidiSource>);
+
+ NoteMode note_mode() const { return (percussive() ? Percussive : Sustained); }
+ void set_note_mode(NoteMode mode) { set_percussive(mode == Percussive); };
+
+ class DiffCommand : public Command {
+ public:
+
+ DiffCommand (boost::shared_ptr<MidiModel> m, const std::string& name);
+
+ const std::string& name () const { return _name; }
+
+ virtual void operator() () = 0;
+ virtual void undo () = 0;
- inline bool operator==(const Note& other)
- { return start == other.start && note == other.note; }
+ virtual int set_state (const XMLNode&, int version) = 0;
+ virtual XMLNode & get_state () = 0;
+
+ boost::shared_ptr<MidiModel> model() const { return _model; }
+
+ protected:
+ boost::shared_ptr<MidiModel> _model;
+ const std::string _name;
- double start;
- double duration;
- uint8_t note;
- uint8_t velocity;
};
- MidiModel(Session& s, size_t size=0);
+ class NoteDiffCommand : public DiffCommand {
+ public:
- void clear() { _notes.clear(); }
+ NoteDiffCommand (boost::shared_ptr<MidiModel> m, const std::string& name) : DiffCommand (m, name) {}
+ NoteDiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node);
- void start_write();
- void end_write(bool delete_stuck=false);
+ enum Property {
+ NoteNumber,
+ Velocity,
+ StartTime,
+ Length,
+ Channel
+ };
- /** 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]; }
+ void operator() ();
+ void undo ();
- inline size_t n_notes() const { return _notes.size(); }
+ int set_state (const XMLNode&, int version);
+ XMLNode & get_state ();
- typedef std::vector<Note> Notes;
-
- inline static bool note_time_comparator (const Note& a, const Note& b) {
- return a.start < b.start;
- }
+ void add (const NotePtr note);
+ void remove (const NotePtr note);
+ void side_effect_remove (const NotePtr note);
- inline Notes& notes() { return _notes; }
- inline const Notes& notes() const { return _notes; }
+ void change (const NotePtr note, Property prop, uint8_t new_value);
+ void change (const NotePtr note, Property prop, TimeType new_time);
- void begin_command();
- Command* current_command() { return _command; }
- void finish_command();
+ bool adds_or_removes() const {
+ return !_added_notes.empty() || !_removed_notes.empty();
+ }
- // Commands
- void add_note(const Note& note);
- void remove_note(const Note& note);
+ NoteDiffCommand& operator+= (const NoteDiffCommand& other);
- sigc::signal<void> ContentsChanged;
-
-private:
- class MidiEditCommand : public Command
- {
+ private:
+ struct NoteChange {
+ NoteDiffCommand::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);
+ };
+
+ /* Currently this class only supports changes of sys-ex time, but could be expanded */
+ class SysExDiffCommand : public DiffCommand {
public:
- MidiEditCommand (MidiModel& m) : _model(m) {}
- //MidiEditCommand (MidiModel&, const XMLNode& node);
-
- void operator()();
- void undo();
-
- /*int set_state (const XMLNode&);
- XMLNode& get_state ();*/
-
- void add_note(const Note& note);
- void remove_note(const Note& note);
+ SysExDiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node);
+
+ enum Property {
+ Time,
+ };
+
+ int set_state (const XMLNode&, int version);
+ XMLNode & get_state ();
+
+ void operator() ();
+ void undo ();
+
+ void change (boost::shared_ptr<Evoral::Event<TimeType> >, TimeType);
private:
- MidiModel& _model;
- std::list<Note> _added_notes;
- std::list<Note> _removed_notes;
+ struct Change {
+ boost::shared_ptr<Evoral::Event<TimeType> > sysex;
+ SysExDiffCommand::Property property;
+ TimeType old_time;
+ TimeType new_time;
+ };
+
+ typedef std::list<Change> ChangeList;
+ ChangeList _changes;
+
+ XMLNode & marshal_change (const Change &);
+ Change unmarshal_change (XMLNode *);
};
- void append_note_on(double time, uint8_t note, uint8_t velocity);
- void append_note_off(double time, uint8_t note);
+ class PatchChangeDiffCommand : public DiffCommand {
+ public:
+ PatchChangeDiffCommand (boost::shared_ptr<MidiModel>, const std::string &);
+ PatchChangeDiffCommand (boost::shared_ptr<MidiModel>, const XMLNode &);
+
+ int set_state (const XMLNode &, int version);
+ XMLNode & get_state ();
+
+ void operator() ();
+ void undo ();
- Session& _session;
+ void add (PatchChangePtr);
+ void remove (PatchChangePtr);
+ void change_time (PatchChangePtr, TimeType);
+ void change_channel (PatchChangePtr, uint8_t);
+ void change_program (PatchChangePtr, uint8_t);
+ void change_bank (PatchChangePtr, int);
- Notes _notes;
-
- typedef std::vector<size_t> WriteNotes;
- WriteNotes _write_notes;
+ enum Property {
+ Time,
+ Channel,
+ Program,
+ Bank
+ };
- MidiEditCommand* _command; ///< In-progress command
+ private:
+ struct Change {
+ PatchChangePtr patch;
+ Property property;
+ union {
+ TimeType old_time;
+ uint8_t old_channel;
+ int old_bank;
+ uint8_t old_program;
+ };
+ union {
+ uint8_t new_channel;
+ TimeType new_time;
+ uint8_t new_program;
+ int new_bank;
+ };
+ };
+
+ typedef std::list<Change> ChangeList;
+ ChangeList _changes;
+
+ std::list<PatchChangePtr> _added;
+ std::list<PatchChangePtr> _removed;
+
+ XMLNode & marshal_change (const Change &);
+ Change unmarshal_change (XMLNode *);
+
+ XMLNode & marshal_patch_change (constPatchChangePtr);
+ PatchChangePtr unmarshal_patch_change (XMLNode *);
+ };
+
+ MidiModel::NoteDiffCommand* new_note_diff_command (const std::string name = "midi edit");
+ MidiModel::SysExDiffCommand* new_sysex_diff_command (const std::string name = "midi edit");
+ MidiModel::PatchChangeDiffCommand* new_patch_change_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 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);
+
+ // 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;
+
+ boost::shared_ptr<const MidiSource> midi_source ();
+ void set_midi_source (boost::shared_ptr<MidiSource>);
+
+ boost::shared_ptr<Evoral::Note<TimeType> > find_note (NotePtr);
+ PatchChangePtr find_patch_change (Evoral::event_id_t);
+ boost::shared_ptr<Evoral::Note<TimeType> > find_note (gint note_id);
+ boost::shared_ptr<Evoral::Event<TimeType> > find_sysex (gint);
+
+ InsertMergePolicy insert_merge_policy () const;
+ void set_insert_merge_policy (InsertMergePolicy);
+
+ boost::shared_ptr<Evoral::Control> control_factory(const Evoral::Parameter& id);
+
+ void insert_silence_at_start (TimeType);
+ void transpose (TimeType, TimeType, int);
+
+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;
+ };
+
+public:
+ WriteLock edit_lock();
+ WriteLock write_lock();
+
+private:
+ friend class DeltaCommand;
+
+ 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);
+
+ void control_list_marked_dirty ();
+
+ PBD::ScopedConnectionList _midi_source_connections;
+
+ // We cannot use a boost::shared_ptr here to avoid a retain cycle
+ boost::weak_ptr<MidiSource> _midi_source;
+ InsertMergePolicy _insert_merge_policy;
};
} /* namespace ARDOUR */
+/* This is a very long comment and stuff oh my god it's so long what are we going to do oh no oh no*/
+
#endif /* __ardour_midi_model_h__ */
projects / ardour.git / blobdiff