libs/evoral/evoral/Sequence.hpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2008 David Robillard <http://drobilla.net>
   3  * Copyright (C) 2000-2008 Paul Davis
   4  *
   5  * Evoral is free software; you can redistribute it and/or modify it under the
   6  * terms of the GNU General Public License as published by the Free Software
   7  * Foundation; either version 2 of the License, or (at your option) any later
   8  * version.
   9  *
  10  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef EVORAL_SEQUENCE_HPP
  20 #define EVORAL_SEQUENCE_HPP
  21
  22 #include <vector>
  23 #include <queue>
  24 #include <set>
  25 #include <list>
  26 #include <utility>
  27 #include <boost/shared_ptr.hpp>
  28 #include <glibmm/thread.h>
  29 #include "evoral/types.hpp"
  30 #include "evoral/Note.hpp"
  31 #include "evoral/Parameter.hpp"
  32 #include "evoral/ControlSet.hpp"
  33 #include "evoral/ControlList.hpp"
  34 #include "evoral/PatchChange.hpp"
  35
  36 namespace Evoral {
  37
  38 class TypeMap;
  39 template<typename Time> class EventSink;
  40 template<typename Time> class Note;
  41 template<typename Time> class Event;
  42
  43 /** An iterator over (the x axis of) a 2-d double coordinate space.
  44  */
  45 class ControlIterator {
  46 public:
  47         ControlIterator(boost::shared_ptr<const ControlList> al, double ax, double ay)
  48                 : list(al)
  49                 , x(ax)
  50                 , y(ay)
  51         {}
  52
  53         boost::shared_ptr<const ControlList> list;
  54         double x;
  55         double y;
  56 };
  57
  58
  59 /** This is a higher level view of events, with separate representations for
  60  * notes (instead of just unassociated note on/off events) and controller data.
  61  * Controller data is represented as a list of time-stamped float values. */
  62 template<typename Time>
  63 class Sequence : virtual public ControlSet {
  64 public:
  65         Sequence(const TypeMap& type_map);
  66         Sequence(const Sequence<Time>& other);
  67
  68 protected:
  69         struct WriteLockImpl {
  70                 WriteLockImpl(Glib::RWLock& s, Glib::Mutex& c)
  71                         : sequence_lock(new Glib::RWLock::WriterLock(s))
  72                         , control_lock(new Glib::Mutex::Lock(c))
  73                 { }
  74                 ~WriteLockImpl() {
  75                         delete sequence_lock;
  76                         delete control_lock;
  77                 }
  78                 Glib::RWLock::WriterLock* sequence_lock;
  79                 Glib::Mutex::Lock*        control_lock;
  80         };
  81
  82 public:
  83
  84         typedef typename boost::shared_ptr<Evoral::Note<Time> >  NotePtr;
  85         typedef typename boost::shared_ptr<const Evoral::Note<Time> >  constNotePtr;
  86
  87         typedef boost::shared_ptr<Glib::RWLock::ReaderLock> ReadLock;
  88         typedef boost::shared_ptr<WriteLockImpl>            WriteLock;
  89
  90         virtual ReadLock  read_lock() const { return ReadLock(new Glib::RWLock::ReaderLock(_lock)); }
  91         virtual WriteLock write_lock()      { return WriteLock(new WriteLockImpl(_lock, _control_lock)); }
  92
  93         void clear();
  94
  95         bool percussive() const     { return _percussive; }
  96         void set_percussive(bool p) { _percussive = p; }
  97
  98         void start_write();
  99         bool writing() const { return _writing; }
 100
 101         enum StuckNoteOption {
 102                 Relax,
 103                 DeleteStuckNotes,
 104                 ResolveStuckNotes
 105         };
 106
 107         void end_write (StuckNoteOption, Time when = 0);
 108
 109         void append(const Event<Time>& ev, Evoral::event_id_t evid);
 110
 111         inline size_t n_notes() const { return _notes.size(); }
 112         inline bool   empty()   const { return _notes.empty() && _sysexes.empty() && _patch_changes.empty() && ControlSet::controls_empty(); }
 113
 114         inline static bool note_time_comparator(const boost::shared_ptr< const Note<Time> >& a,
 115                                                 const boost::shared_ptr< const Note<Time> >& b) {
 116                 return a->time() < b->time();
 117         }
 118
 119         struct NoteNumberComparator {
 120                 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
 121                                        const boost::shared_ptr< const Note<Time> > b) const {
 122                         return a->note() < b->note();
 123                 }
 124         };
 125
 126         struct EarlierNoteComparator {
 127                 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
 128                                        const boost::shared_ptr< const Note<Time> > b) const {
 129                         return a->time() < b->time();
 130                 }
 131         };
 132
 133         struct LaterNoteComparator {
 134                 typedef const Note<Time>* value_type;
 135                 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
 136                                        const boost::shared_ptr< const Note<Time> > b) const {
 137                         return a->time() > b->time();
 138                 }
 139         };
 140
 141         struct LaterNoteEndComparator {
 142                 typedef const Note<Time>* value_type;
 143                 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
 144                                        const boost::shared_ptr< const Note<Time> > b) const {
 145                         return a->end_time() > b->end_time();
 146                 }
 147         };
 148
 149         typedef std::multiset<NotePtr, EarlierNoteComparator> Notes;
 150         inline       Notes& notes()       { return _notes; }
 151         inline const Notes& notes() const { return _notes; }
 152
 153         enum NoteOperator {
 154                 PitchEqual,
 155                 PitchLessThan,
 156                 PitchLessThanOrEqual,
 157                 PitchGreater,
 158                 PitchGreaterThanOrEqual,
 159                 VelocityEqual,
 160                 VelocityLessThan,
 161                 VelocityLessThanOrEqual,
 162                 VelocityGreater,
 163                 VelocityGreaterThanOrEqual,
 164         };
 165
 166         void get_notes (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
 167
 168         void remove_overlapping_notes ();
 169         void trim_overlapping_notes ();
 170         void remove_duplicate_notes ();
 171
 172         enum OverlapPitchResolution {
 173                 LastOnFirstOff,
 174                 FirstOnFirstOff
 175         };
 176
 177         bool overlapping_pitches_accepted() const { return _overlapping_pitches_accepted; }
 178         void overlapping_pitches_accepted(bool yn)  { _overlapping_pitches_accepted = yn; }
 179         OverlapPitchResolution overlap_pitch_resolution() const { return _overlap_pitch_resolution; }
 180         void set_overlap_pitch_resolution(OverlapPitchResolution opr);
 181
 182         void set_notes (const Sequence<Time>::Notes& n);
 183
 184         typedef std::vector< boost::shared_ptr< Event<Time> > > SysExes;
 185         inline       SysExes& sysexes()       { return _sysexes; }
 186         inline const SysExes& sysexes() const { return _sysexes; }
 187
 188         typedef boost::shared_ptr<PatchChange<Time> > PatchChangePtr;
 189         typedef boost::shared_ptr<const PatchChange<Time> > constPatchChangePtr;
 190
 191         struct EarlierPatchChangeComparator {
 192                 inline bool operator() (constPatchChangePtr a, constPatchChangePtr b) const {
 193                         return a->time() < b->time();
 194                 }
 195         };
 196
 197         typedef std::multiset<PatchChangePtr, EarlierPatchChangeComparator> PatchChanges;
 198         inline       PatchChanges& patch_changes ()       { return _patch_changes; }
 199         inline const PatchChanges& patch_changes () const { return _patch_changes; }
 200
 201         void dump (std::ostream&) const;
 202
 203 private:
 204         typedef std::priority_queue<NotePtr, std::deque<NotePtr>, LaterNoteEndComparator> ActiveNotes;
 205 public:
 206
 207         /** Read iterator */
 208         class const_iterator {
 209         public:
 210                 const_iterator();
 211                 const_iterator(const Sequence<Time>& seq, Time t, bool, std::set<Evoral::Parameter> const &);
 212                 ~const_iterator();
 213
 214                 inline bool valid() const { return !_is_end && _event; }
 215                 //inline bool locked() const { return _locked; }
 216
 217                 void invalidate();
 218
 219                 const Event<Time>& operator*()  const { return *_event;  }
 220                 const boost::shared_ptr< Event<Time> > operator->() const  { return _event; }
 221                 const boost::shared_ptr< Event<Time> > get_event_pointer() { return _event; }
 222
 223                 const const_iterator& operator++(); // prefix only
 224
 225                 bool operator==(const const_iterator& other) const;
 226                 bool operator!=(const const_iterator& other) const { return ! operator==(other); }
 227
 228                 const_iterator& operator=(const const_iterator& other);
 229
 230         private:
 231                 friend class Sequence<Time>;
 232
 233                 typedef std::vector<ControlIterator> ControlIterators;
 234                 enum MIDIMessageType { NIL, NOTE_ON, NOTE_OFF, CONTROL, SYSEX, PATCH_CHANGE };
 235
 236                 const Sequence<Time>*                 _seq;
 237                 boost::shared_ptr< Event<Time> >      _event;
 238                 mutable ActiveNotes                   _active_notes;
 239                 /** If the iterator is pointing at a patch change, this is the index of the
 240                  *  sub-message within that change.
 241                  */
 242                 int                                   _active_patch_change_message;
 243                 MIDIMessageType                       _type;
 244                 bool                                  _is_end;
 245                 typename Sequence::ReadLock           _lock;
 246                 typename Notes::const_iterator        _note_iter;
 247                 typename SysExes::const_iterator      _sysex_iter;
 248                 typename PatchChanges::const_iterator _patch_change_iter;
 249                 ControlIterators                      _control_iters;
 250                 ControlIterators::iterator            _control_iter;
 251                 bool                                  _force_discrete;
 252         };
 253
 254         const_iterator begin (
 255                 Time t = 0,
 256                 bool force_discrete = false,
 257                 std::set<Evoral::Parameter> const & f = std::set<Evoral::Parameter> ()) const {
 258                 return const_iterator (*this, t, force_discrete, f);
 259         }
 260
 261         const const_iterator& end() const { return _end_iter; }
 262
 263         typename Notes::const_iterator note_lower_bound (Time t) const;
 264         typename PatchChanges::const_iterator patch_change_lower_bound (Time t) const;
 265
 266         bool control_to_midi_event(boost::shared_ptr< Event<Time> >& ev,
 267                                    const ControlIterator&            iter) const;
 268
 269         bool edited() const      { return _edited; }
 270         void set_edited(bool yn) { _edited = yn; }
 271
 272         bool overlaps (const NotePtr& ev,
 273                        const NotePtr& ignore_this_note) const;
 274         bool contains (const NotePtr& ev) const;
 275
 276         bool add_note_unlocked (const NotePtr note, void* arg = 0);
 277         void remove_note_unlocked(const constNotePtr note);
 278
 279         void add_patch_change_unlocked (const PatchChangePtr);
 280         void remove_patch_change_unlocked (const constPatchChangePtr);
 281
 282         uint8_t lowest_note()  const { return _lowest_note; }
 283         uint8_t highest_note() const { return _highest_note; }
 284
 285
 286 protected:
 287         bool                   _edited;
 288         bool                   _overlapping_pitches_accepted;
 289         OverlapPitchResolution _overlap_pitch_resolution;
 290         mutable Glib::RWLock   _lock;
 291         bool                   _writing;
 292
 293         virtual int resolve_overlaps_unlocked (const NotePtr, void* /* arg */ = 0) {
 294                 return 0;
 295         }
 296
 297         typedef std::multiset<NotePtr, NoteNumberComparator>  Pitches;
 298         inline       Pitches& pitches(uint8_t chan)       { return _pitches[chan&0xf]; }
 299         inline const Pitches& pitches(uint8_t chan) const { return _pitches[chan&0xf]; }
 300
 301         virtual void control_list_marked_dirty ();
 302
 303 private:
 304         friend class const_iterator;
 305
 306         bool overlaps_unlocked (const NotePtr& ev, const NotePtr& ignore_this_note) const;
 307         bool contains_unlocked (const NotePtr& ev) const;
 308
 309         void append_note_on_unlocked (NotePtr, Evoral::event_id_t);
 310         void append_note_off_unlocked(NotePtr);
 311         void append_control_unlocked(const Parameter& param, Time time, double value, Evoral::event_id_t);
 312         void append_sysex_unlocked(const MIDIEvent<Time>& ev, Evoral::event_id_t);
 313         void append_patch_change_unlocked (const PatchChange<Time>&, Evoral::event_id_t);
 314
 315         void get_notes_by_pitch (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
 316         void get_notes_by_velocity (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
 317
 318         const TypeMap& _type_map;
 319
 320         Notes        _notes;       // notes indexed by time
 321         Pitches      _pitches[16]; // notes indexed by channel+pitch
 322         SysExes      _sysexes;
 323         PatchChanges _patch_changes;
 324
 325         typedef std::multiset<NotePtr, EarlierNoteComparator> WriteNotes;
 326         WriteNotes _write_notes[16];
 327
 328         /** Current bank number on each channel so that we know what
 329          *  to put in PatchChange events when program changes are
 330          *  seen.
 331          */
 332         int _bank[16];
 333
 334         const   const_iterator _end_iter;
 335         bool                   _percussive;
 336
 337         uint8_t _lowest_note;
 338         uint8_t _highest_note;
 339 };
 340
 341
 342 } // namespace Evoral
 343
 344 // template<typename Time> std::ostream& operator<<(std::ostream& o, const Evoral::Sequence<Time>& s) { s.dump (o); return o; }
 345
 346 #endif // EVORAL_SEQUENCE_HPP
 347