summaryrefslogtreecommitdiff
path: root/libs/evoral/evoral/Sequence.h
diff options
context:
space:
mode:
Diffstat (limited to 'libs/evoral/evoral/Sequence.h')
-rw-r--r--libs/evoral/evoral/Sequence.h381
1 files changed, 381 insertions, 0 deletions
diff --git a/libs/evoral/evoral/Sequence.h b/libs/evoral/evoral/Sequence.h
new file mode 100644
index 0000000000..04864dde8d
--- /dev/null
+++ b/libs/evoral/evoral/Sequence.h
@@ -0,0 +1,381 @@
+/*
+ * Copyright (C) 2008-2016 David Robillard <d@drobilla.net>
+ * Copyright (C) 2009-2012 Hans Baier <hansfbaier@googlemail.com>
+ * Copyright (C) 2009-2013 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2010-2011 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2013-2015 John Emmas <john@creativepost.co.uk>
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef EVORAL_SEQUENCE_HPP
+#define EVORAL_SEQUENCE_HPP
+
+#include <vector>
+#include <queue>
+#include <set>
+#include <list>
+#include <utility>
+#include <boost/shared_ptr.hpp>
+#include <glibmm/threads.h>
+
+#include "evoral/visibility.h"
+#include "evoral/Note.h"
+#include "evoral/ControlSet.h"
+#include "evoral/ControlList.h"
+#include "evoral/PatchChange.h"
+
+namespace Evoral {
+
+class Parameter;
+class TypeMap;
+template<typename Time> class EventSink;
+template<typename Time> class Note;
+template<typename Time> class Event;
+
+/** An iterator over (the x axis of) a 2-d double coordinate space.
+ */
+class /*LIBEVORAL_API*/ ControlIterator {
+public:
+ ControlIterator(boost::shared_ptr<const ControlList> al, double ax, double ay)
+ : list(al)
+ , x(ax)
+ , y(ay)
+ {}
+
+ boost::shared_ptr<const ControlList> list;
+ double x;
+ double y;
+};
+
+
+/** This is a higher level view of events, with separate representations for
+ * notes (instead of just unassociated note on/off events) and controller data.
+ * Controller data is represented as a list of time-stamped float values. */
+template<typename Time>
+class LIBEVORAL_API Sequence : virtual public ControlSet {
+public:
+ Sequence(const TypeMap& type_map);
+ Sequence(const Sequence<Time>& other);
+
+protected:
+ struct WriteLockImpl {
+ WriteLockImpl(Glib::Threads::RWLock& s, Glib::Threads::Mutex& c)
+ : sequence_lock(new Glib::Threads::RWLock::WriterLock(s))
+ , control_lock(new Glib::Threads::Mutex::Lock(c)) { }
+ ~WriteLockImpl() {
+ delete sequence_lock;
+ delete control_lock;
+ }
+ Glib::Threads::RWLock::WriterLock* sequence_lock;
+ Glib::Threads::Mutex::Lock* control_lock;
+ };
+
+public:
+
+ typedef typename boost::shared_ptr<Evoral::Note<Time> > NotePtr;
+ typedef typename boost::weak_ptr<Evoral::Note<Time> > WeakNotePtr;
+ typedef typename boost::shared_ptr<const Evoral::Note<Time> > constNotePtr;
+
+ typedef boost::shared_ptr<Glib::Threads::RWLock::ReaderLock> ReadLock;
+ typedef boost::shared_ptr<WriteLockImpl> WriteLock;
+
+ virtual ReadLock read_lock() const { return ReadLock(new Glib::Threads::RWLock::ReaderLock(_lock)); }
+ virtual WriteLock write_lock() { return WriteLock(new WriteLockImpl(_lock, _control_lock)); }
+
+ void clear();
+
+ bool percussive() const { return _percussive; }
+ void set_percussive(bool p) { _percussive = p; }
+
+ void start_write();
+ bool writing() const { return _writing; }
+
+ enum StuckNoteOption {
+ Relax,
+ DeleteStuckNotes,
+ ResolveStuckNotes
+ };
+
+ void end_write (StuckNoteOption, Time when = Time());
+
+ void append(const Event<Time>& ev, Evoral::event_id_t evid);
+
+ const TypeMap& type_map() const { return _type_map; }
+
+ inline size_t n_notes() const { return _notes.size(); }
+ inline bool empty() const { return _notes.empty() && _sysexes.empty() && _patch_changes.empty() && ControlSet::controls_empty(); }
+
+ inline static bool note_time_comparator(const boost::shared_ptr< const Note<Time> >& a,
+ const boost::shared_ptr< const Note<Time> >& b) {
+ return a->time() < b->time();
+ }
+
+ struct NoteNumberComparator {
+ inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
+ const boost::shared_ptr< const Note<Time> > b) const {
+ return a->note() < b->note();
+ }
+ };
+
+ struct EarlierNoteComparator {
+ inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
+ const boost::shared_ptr< const Note<Time> > b) const {
+ return a->time() < b->time();
+ }
+ };
+
+#if 0 // NOT USED
+ struct LaterNoteComparator {
+ typedef const Note<Time>* value_type;
+ inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
+ const boost::shared_ptr< const Note<Time> > b) const {
+ return a->time() > b->time();
+ }
+ };
+#endif
+
+ struct LaterNoteEndComparator {
+ typedef const Note<Time>* value_type;
+ inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
+ const boost::shared_ptr< const Note<Time> > b) const {
+ return a->end_time().to_double() > b->end_time().to_double();
+ }
+ };
+
+ typedef std::multiset<NotePtr, EarlierNoteComparator> Notes;
+ inline Notes& notes() { return _notes; }
+ inline const Notes& notes() const { return _notes; }
+
+ enum NoteOperator {
+ PitchEqual,
+ PitchLessThan,
+ PitchLessThanOrEqual,
+ PitchGreater,
+ PitchGreaterThanOrEqual,
+ VelocityEqual,
+ VelocityLessThan,
+ VelocityLessThanOrEqual,
+ VelocityGreater,
+ VelocityGreaterThanOrEqual,
+ };
+
+ void get_notes (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
+
+ void remove_overlapping_notes ();
+ void trim_overlapping_notes ();
+ void remove_duplicate_notes ();
+
+ enum OverlapPitchResolution {
+ LastOnFirstOff,
+ FirstOnFirstOff
+ };
+
+ bool overlapping_pitches_accepted() const { return _overlapping_pitches_accepted; }
+ void overlapping_pitches_accepted(bool yn) { _overlapping_pitches_accepted = yn; }
+ OverlapPitchResolution overlap_pitch_resolution() const { return _overlap_pitch_resolution; }
+ void set_overlap_pitch_resolution(OverlapPitchResolution opr);
+
+ void set_notes (const typename Sequence<Time>::Notes& n);
+
+ typedef boost::shared_ptr< Event<Time> > SysExPtr;
+ typedef boost::shared_ptr<const Event<Time> > constSysExPtr;
+
+ struct EarlierSysExComparator {
+ inline bool operator() (constSysExPtr a, constSysExPtr b) const {
+ return a->time() < b->time();
+ }
+ };
+
+ typedef std::multiset<SysExPtr, EarlierSysExComparator> SysExes;
+ inline SysExes& sysexes() { return _sysexes; }
+ inline const SysExes& sysexes() const { return _sysexes; }
+
+ typedef boost::shared_ptr<PatchChange<Time> > PatchChangePtr;
+ typedef boost::shared_ptr<const PatchChange<Time> > constPatchChangePtr;
+
+ struct EarlierPatchChangeComparator {
+ inline bool operator() (constPatchChangePtr a, constPatchChangePtr b) const {
+ return a->time() < b->time();
+ }
+ };
+
+ typedef std::multiset<PatchChangePtr, EarlierPatchChangeComparator> PatchChanges;
+ inline PatchChanges& patch_changes () { return _patch_changes; }
+ inline const PatchChanges& patch_changes () const { return _patch_changes; }
+
+ void dump (std::ostream&) const;
+
+private:
+ typedef std::priority_queue<NotePtr, std::deque<NotePtr>, LaterNoteEndComparator> ActiveNotes;
+public:
+
+ /** Read iterator */
+ class LIBEVORAL_API const_iterator {
+ public:
+ const_iterator();
+ const_iterator(const Sequence<Time>& seq,
+ Time t,
+ bool force_discrete,
+ const std::set<Evoral::Parameter>& filtered,
+ const std::set<WeakNotePtr>* active_notes=NULL);
+
+ inline bool valid() const { return !_is_end && _event; }
+
+ void invalidate(std::set<WeakNotePtr>* notes);
+
+ const Event<Time>& operator*() const { return *_event; }
+ const boost::shared_ptr< const Event<Time> > operator->() const { return _event; }
+
+ 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);
+
+ private:
+ friend class Sequence<Time>;
+
+ Time choose_next(Time earliest_t);
+ void set_event();
+
+ typedef std::vector<ControlIterator> ControlIterators;
+ enum MIDIMessageType { NIL, NOTE_ON, NOTE_OFF, CONTROL, SYSEX, PATCH_CHANGE };
+
+ const Sequence<Time>* _seq;
+ boost::shared_ptr< Event<Time> > _event;
+ mutable ActiveNotes _active_notes;
+ /** If the iterator is pointing at a patch change, this is the index of the
+ * sub-message within that change.
+ */
+ int _active_patch_change_message;
+ MIDIMessageType _type;
+ bool _is_end;
+ typename Sequence::ReadLock _lock;
+ typename Notes::const_iterator _note_iter;
+ typename SysExes::const_iterator _sysex_iter;
+ typename PatchChanges::const_iterator _patch_change_iter;
+ ControlIterators _control_iters;
+ ControlIterators::iterator _control_iter;
+ bool _force_discrete;
+ };
+
+ const_iterator begin (
+ Time t = Time(),
+ bool force_discrete = false,
+ const std::set<Evoral::Parameter>& f = std::set<Evoral::Parameter>(),
+ const std::set<WeakNotePtr>* active_notes = NULL) const {
+ return const_iterator (*this, t, force_discrete, f, active_notes);
+ }
+
+ const const_iterator& end() const { return _end_iter; }
+
+ // CONST iterator implementations (x3)
+ typename Notes::const_iterator note_lower_bound (Time t) const;
+ typename PatchChanges::const_iterator patch_change_lower_bound (Time t) const;
+ typename SysExes::const_iterator sysex_lower_bound (Time t) const;
+
+ // NON-CONST iterator implementations (x3)
+ typename Notes::iterator note_lower_bound (Time t);
+ typename PatchChanges::iterator patch_change_lower_bound (Time t);
+ typename SysExes::iterator sysex_lower_bound (Time t);
+
+ bool control_to_midi_event(boost::shared_ptr< Event<Time> >& ev,
+ const ControlIterator& iter) const;
+
+ bool edited() const { return _edited; }
+ void set_edited(bool yn) { _edited = yn; }
+
+ bool overlaps (const NotePtr& ev,
+ const NotePtr& ignore_this_note) const;
+ bool contains (const NotePtr& ev) const;
+
+ bool add_note_unlocked (const NotePtr note, void* arg = 0);
+ void remove_note_unlocked(const constNotePtr note);
+
+ void add_patch_change_unlocked (const PatchChangePtr);
+ void remove_patch_change_unlocked (const constPatchChangePtr);
+
+ void add_sysex_unlocked (const SysExPtr);
+ void remove_sysex_unlocked (const SysExPtr);
+
+ uint8_t lowest_note() const { return _lowest_note; }
+ uint8_t highest_note() const { return _highest_note; }
+
+
+protected:
+ bool _edited;
+ bool _overlapping_pitches_accepted;
+ OverlapPitchResolution _overlap_pitch_resolution;
+ mutable Glib::Threads::RWLock _lock;
+ bool _writing;
+
+ virtual int resolve_overlaps_unlocked (const NotePtr, void* /* arg */ = 0) {
+ return 0;
+ }
+
+ typedef std::multiset<NotePtr, NoteNumberComparator> Pitches;
+ inline Pitches& pitches(uint8_t chan) { return _pitches[chan&0xf]; }
+ inline const Pitches& pitches(uint8_t chan) const { return _pitches[chan&0xf]; }
+
+ virtual void control_list_marked_dirty ();
+
+private:
+ friend class const_iterator;
+
+ bool overlaps_unlocked (const NotePtr& ev, const NotePtr& ignore_this_note) const;
+ bool contains_unlocked (const NotePtr& ev) const;
+
+ void append_note_on_unlocked(const Event<Time>& event, Evoral::event_id_t);
+ void append_note_off_unlocked(const Event<Time>& event);
+ void append_control_unlocked(const Parameter& param, Time time, double value, Evoral::event_id_t);
+ void append_sysex_unlocked(const Event<Time>& ev, Evoral::event_id_t);
+ void append_patch_change_unlocked(const PatchChange<Time>&, Evoral::event_id_t);
+
+ void get_notes_by_pitch (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
+ void get_notes_by_velocity (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
+
+ const TypeMap& _type_map;
+
+ Notes _notes; // notes indexed by time
+ Pitches _pitches[16]; // notes indexed by channel+pitch
+ SysExes _sysexes;
+ PatchChanges _patch_changes;
+
+ typedef std::multiset<NotePtr, EarlierNoteComparator> WriteNotes;
+ WriteNotes _write_notes[16];
+
+ /** Current bank number on each channel so that we know what
+ * to put in PatchChange events when program changes are
+ * seen.
+ */
+ int _bank[16];
+
+ const const_iterator _end_iter;
+ bool _percussive;
+
+ uint8_t _lowest_note;
+ uint8_t _highest_note;
+};
+
+
+} // namespace Evoral
+
+template<typename Time> /*LIBEVORAL_API*/ std::ostream& operator<<(std::ostream& o, const Evoral::Sequence<Time>& s) { s.dump (o); return o; }
+
+
+#endif // EVORAL_SEQUENCE_HPP
+