/*
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 <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 <glibmm/threads.h>
+#include "pbd/command.h"
+#include "ardour/libardour_visibility.h"
+#include "ardour/types.h"
+#include "ardour/midi_buffer.h"
+#include "ardour/midi_ring_buffer.h"
+#include "ardour/automatable_sequence.h"
+#include "ardour/libardour_visibility.h"
+#include "ardour/types.h"
+#include "evoral/Note.hpp"
+#include "evoral/Sequence.hpp"
namespace ARDOUR {
class Session;
class MidiSource;
-
-
-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 LIBARDOUR_API MidiModel : public AutomatableSequence<Evoral::MusicalTime> {
public:
- MidiModel(MidiSource *s, size_t size=0);
-
- void write_lock();
- void write_unlock();
+ typedef Evoral::MusicalTime TimeType;
- void read_lock() const;
- void read_unlock() const;
+ MidiModel (boost::shared_ptr<MidiSource>);
- void clear();
+ NoteMode note_mode() const { return (percussive() ? Percussive : Sustained); }
+ void set_note_mode(NoteMode mode) { set_percussive(mode == Percussive); };
- NoteMode note_mode() const { return _note_mode; }
- void set_note_mode(NoteMode mode) { _note_mode = mode; }
+ class LIBARDOUR_API DiffCommand : public Command {
+ public:
- void start_write();
- bool writing() const { return _writing; }
- void end_write(bool delete_stuck=false);
+ DiffCommand (boost::shared_ptr<MidiModel> m, const std::string& name);
- size_t read (MidiRingBuffer& dst, nframes_t start, nframes_t nframes, nframes_t stamp_offset, nframes_t negative_stamp_offset) const;
+ const std::string& name () const { return _name; }
- /** 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]; }
+ virtual void operator() () = 0;
+ virtual void undo () = 0;
- inline size_t n_notes() const { return _notes.size(); }
- inline bool empty() const { return _notes.size() == 0 && _controls.size() == 0; }
+ virtual int set_state (const XMLNode&, int version) = 0;
+ virtual XMLNode & get_state () = 0;
-
- 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 { return _model; }
- 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();
- }
- };
+ protected:
+ boost::shared_ptr<MidiModel> _model;
+ const std::string _name;
- 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.
- */
- class DeltaCommand : public Command
- {
+ class LIBARDOUR_API NoteDiffCommand : public DiffCommand {
public:
- DeltaCommand (boost::shared_ptr<MidiModel> m, const std::string& name);
- DeltaCommand (boost::shared_ptr<MidiModel>, const XMLNode& node);
- const std::string& name() const { return _name; }
-
- void operator()();
- void undo();
-
- int set_state (const XMLNode&);
- XMLNode& get_state ();
+ NoteDiffCommand (boost::shared_ptr<MidiModel> m, const std::string& name) : DiffCommand (m, name) {}
+ NoteDiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node);
+
+ enum Property {
+ NoteNumber,
+ Velocity,
+ StartTime,
+ Length,
+ Channel
+ };
+
+ void operator() ();
+ void undo ();
+
+ int set_state (const XMLNode&, int version);
+ XMLNode & get_state ();
+
+ void add (const NotePtr note);
+ void remove (const NotePtr note);
+ void side_effect_remove (const NotePtr note);
+
+ void change (const NotePtr note, Property prop, uint8_t new_value);
+ void change (const NotePtr note, Property prop, TimeType new_time);
+
+ bool adds_or_removes() const {
+ return !_added_notes.empty() || !_removed_notes.empty();
+ }
- void add(const boost::shared_ptr<Note> note);
- void remove(const boost::shared_ptr<Note> note);
+ NoteDiffCommand& operator+= (const NoteDiffCommand& other);
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;
-
+ struct NoteChange {
+ NoteDiffCommand::Property property;
+ NotePtr note;
+ uint32_t note_id;
+
+ 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);
};
- MidiModel::DeltaCommand* new_delta_command(const std::string name="midi edit");
- void apply_command(Command* cmd);
+ /* Currently this class only supports changes of sys-ex time, but could be expanded */
+ class LIBARDOUR_API SysExDiffCommand : public DiffCommand {
+ public:
+ SysExDiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node);
+
+ enum Property {
+ Time,
+ };
+
+ int set_state (const XMLNode&, int version);
+ XMLNode & get_state ();
- bool edited() const { return _edited; }
- void set_edited(bool yn) { _edited = yn; }
+ void remove (SysExPtr sysex);
+ void operator() ();
+ void undo ();
+
+ void change (boost::shared_ptr<Evoral::Event<TimeType> >, TimeType);
+
+ private:
+ struct Change {
+ boost::shared_ptr<Evoral::Event<TimeType> > sysex;
+ gint sysex_id;
+ SysExDiffCommand::Property property;
+ TimeType old_time;
+ TimeType new_time;
+ };
+
+ typedef std::list<Change> ChangeList;
+ ChangeList _changes;
+
+ std::list<SysExPtr> _removed;
+
+ XMLNode & marshal_change (const Change &);
+ Change unmarshal_change (XMLNode *);
+ };
+
+ class LIBARDOUR_API 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 ();
+
+ 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);
+
+ enum Property {
+ Time,
+ Channel,
+ Program,
+ Bank
+ };
+
+ private:
+ struct Change {
+ PatchChangePtr patch;
+ Property property;
+ gint patch_id;
+ 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;
+ };
+
+ Change() : patch_id (-1) {}
+ };
+
+ 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);
-
- // MidiModel doesn't use the normal AutomationList serialisation code, as CC data is in the .mid
+ 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; }
- sigc::signal<void> ContentsChanged;
-
- /** Read iterator */
- class const_iterator {
- public:
- const_iterator(const MidiModel& model, double t);
- ~const_iterator();
+ PBD::Signal0<void> ContentsChanged;
- inline bool locked() const { return _locked; }
+ boost::shared_ptr<const MidiSource> midi_source ();
+ void set_midi_source (boost::shared_ptr<MidiSource>);
- const MIDI::Event& operator*() const { return _event; }
- const MIDI::Event* operator->() const { return &_event; }
+ 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);
- 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);
+ InsertMergePolicy insert_merge_policy () const;
+ void set_insert_merge_policy (InsertMergePolicy);
- private:
- friend class MidiModel;
-
- const MidiModel* _model;
- 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;
+ 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::Threads::Mutex::Lock* slock, Glib::Threads::RWLock& s, Glib::Threads::Mutex& c)
+ : AutomatableSequence<TimeType>::WriteLockImpl(s, c)
+ , source_lock (slock)
+ {}
+ ~WriteLockImpl() {
+ delete source_lock;
+ }
+ Glib::Threads::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; }
-
+
+public:
+ WriteLock edit_lock();
+ 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;
- bool control_to_midi_event(MIDI::Event& ev, const MidiControlIterator& iter) const;
-
-#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;
-
+
+ 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
- MidiSource* _midi_source;
+ 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