libs/ardour/ardour/note_fixer.h

   1 /*
   2     Copyright (C) 2015 Paul Davis
   3     Author: David Robillard
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __ardour_note_fixer_h__
  21 #define __ardour_note_fixer_h__
  22
  23 #include <list>
  24
  25 #include <boost/utility.hpp>
  26
  27 #include "ardour/midi_model.h"
  28 #include "ardour/types.h"
  29 #include "evoral/Beats.hpp"
  30 #include "evoral/Note.hpp"
  31
  32 namespace Evoral { template<typename Time> class EventSink; }
  33
  34 namespace ARDOUR {
  35
  36 class BeatsFramesConverter;
  37 class MidiStateTracker;
  38 class TempoMap;
  39
  40 /** A tracker and compensator for note edit operations.
  41  *
  42  * This monitors edit operations sent to a model that affect active notes
  43  * during a read, and maintains a queue of synthetic events that should be sent
  44  * at the start of the next read to maintain coherent MIDI state.
  45  */
  46 class NoteFixer : public boost::noncopyable
  47 {
  48 public:
  49         typedef Evoral::Note<Evoral::Beats> Note;
  50
  51         ~NoteFixer();
  52
  53         /** Clear all internal state. */
  54         void clear();
  55
  56         /** Handle a region edit during read.
  57          *
  58          * This must be called before the command is applied to the model.  Events
  59          * are enqueued to compensate for edits which should be later sent with
  60          * emit() at the start of the next read.
  61          *
  62          * @param cmd Command to compensate for.
  63          * @param origin Timeline position of edited source.
  64          * @param pos Current read position (last read end).
  65          */
  66         void prepare(TempoMap&                          tempo_map,
  67                      const MidiModel::NoteDiffCommand*  cmd,
  68                      framepos_t                         origin,
  69                      framepos_t                         pos,
  70                      std::set< boost::weak_ptr<Note> >& active_notes);
  71
  72         /** Emit any pending edit compensation events.
  73          *
  74          * @param dst Destination for events.
  75          * @param pos Timestamp to be used for every event, should be the start of
  76          * the read block immediately following any calls to prepare().
  77          * @param tracker Tracker to update with emitted events.
  78          */
  79         void emit(Evoral::EventSink<framepos_t>& dst,
  80                   framepos_t                     pos,
  81                   MidiStateTracker&              tracker);
  82
  83 private:
  84         typedef Evoral::Event<framepos_t> Event;
  85         typedef std::list<Event*>         Events;
  86
  87         /** Copy a beats event to a frames event with the given time stamp. */
  88         Event* copy_event(framepos_t time, const Evoral::Event<Evoral::Beats>& ev);
  89
  90         /** Return true iff `note` is active at `pos`. */
  91         bool note_is_active(const BeatsFramesConverter& converter,
  92                             boost::shared_ptr<Note>     note,
  93                             framepos_t                  pos);
  94
  95         Events _events;
  96 };
  97
  98 } /* namespace ARDOUR */
  99
 100 #endif  /* __ardour_note_fixer_h__ */
 101
 102