libs/ardour/ardour/midi_source.h

   1 /*
   2     Copyright (C) 2006 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_midi_source_h__
  21 #define __ardour_midi_source_h__
  22
  23 #include <string>
  24 #include <time.h>
  25 #include <glibmm/threads.h>
  26 #include <boost/enable_shared_from_this.hpp>
  27 #include "pbd/stateful.h"
  28 #include "pbd/xml++.h"
  29 #include "evoral/Sequence.hpp"
  30 #include "ardour/ardour.h"
  31 #include "ardour/buffer.h"
  32 #include "ardour/source.h"
  33 #include "ardour/beats_frames_converter.h"
  34
  35 namespace ARDOUR {
  36
  37 class MidiChannelFilter;
  38 class MidiStateTracker;
  39 class MidiModel;
  40
  41 template<typename T> class MidiRingBuffer;
  42
  43 /** Source for MIDI data */
  44 class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_shared_from_this<MidiSource>
  45 {
  46   public:
  47         typedef Evoral::Beats TimeType;
  48
  49         MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
  50         MidiSource (Session& session, const XMLNode&);
  51         virtual ~MidiSource ();
  52
  53         /** Write the data in the given time range to another MidiSource
  54          * \param newsrc MidiSource to which data will be written. Should be a
  55          *        new, empty source. If it already has contents, the results are
  56          *        undefined. Source must be writable.
  57          * \param begin time of earliest event that can be written.
  58          * \param end time of latest event that can be written.
  59          * \return zero on success, non-zero if the write failed for any reason.
  60          */
  61         int write_to (const Lock&                   lock,
  62                       boost::shared_ptr<MidiSource> newsrc,
  63                       Evoral::Beats                 begin = Evoral::MinBeats,
  64                       Evoral::Beats                 end   = Evoral::MaxBeats);
  65
  66         /** Read the data in a given time range from the MIDI source.
  67          * All time stamps in parameters are in audio frames (even if the source has tempo time).
  68          * \param dst Ring buffer where read events are written.
  69          * \param source_start Start position of the SOURCE in this read context.
  70          * \param start Start of range to be read.
  71          * \param cnt Length of range to be read (in audio frames).
  72          * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking.
  73          * \param filtered Parameters whose MIDI messages will not be returned.
  74          */
  75         virtual framecnt_t midi_read (const Lock&                        lock,
  76                                       Evoral::EventSink<framepos_t>&     dst,
  77                                       framepos_t                         source_start,
  78                                       framepos_t                         start,
  79                                       framecnt_t                         cnt,
  80                                       MidiStateTracker*                  tracker,
  81                                       MidiChannelFilter*                 filter,
  82                                       const std::set<Evoral::Parameter>& filtered,
  83                                       double                             beat,
  84                                       double                             start_beat) const;
  85
  86         /** Write data from a MidiRingBuffer to this source.
  87          *  @param source Source to read from.
  88          *  @param source_start This source's start position in session frames.
  89          *  @param cnt The length of time to write.
  90          */
  91         virtual framecnt_t midi_write (const Lock&                 lock,
  92                                        MidiRingBuffer<framepos_t>& src,
  93                                        framepos_t                  source_start,
  94                                        framecnt_t                  cnt);
  95
  96         /** Append a single event with a timestamp in beats.
  97          *
  98          * Caller must ensure that the event is later than the last written event.
  99          */
 100         virtual void append_event_beats(const Lock&                         lock,
 101                                         const Evoral::Event<Evoral::Beats>& ev) = 0;
 102
 103         /** Append a single event with a timestamp in frames.
 104          *
 105          * Caller must ensure that the event is later than the last written event.
 106          */
 107         virtual void append_event_frames(const Lock&                      lock,
 108                                          const Evoral::Event<framepos_t>& ev,
 109                                          framepos_t                       source_start) = 0;
 110
 111         virtual bool       empty () const;
 112         virtual framecnt_t length (framepos_t pos) const;
 113         virtual void       update_length (framecnt_t);
 114
 115         virtual void mark_streaming_midi_write_started (const Lock& lock, NoteMode mode);
 116         virtual void mark_streaming_write_started (const Lock& lock);
 117         virtual void mark_streaming_write_completed (const Lock& lock);
 118
 119         /** Mark write starting with the given time parameters.
 120          *
 121          * This is called by MidiDiskStream::process before writing to the capture
 122          * buffer which will be later read by midi_read().
 123          *
 124          * @param position The timeline position the source now starts at.
 125          * @param capture_length The current length of the capture, which may not
 126          * be zero if record is armed while rolling.
 127          * @param loop_length The loop length if looping, otherwise zero.
 128          */
 129         void mark_write_starting_now (framecnt_t position,
 130                                       framecnt_t capture_length,
 131                                       framecnt_t loop_length);
 132
 133         /* like ::mark_streaming_write_completed() but with more arguments to
 134          * allow control over MIDI-specific behaviour. Expected to be used only
 135          * when recording actual MIDI input, rather then when importing files
 136          * etc.
 137          */
 138         virtual void mark_midi_streaming_write_completed (
 139                 const Lock&                                      lock,
 140                 Evoral::Sequence<Evoral::Beats>::StuckNoteOption stuck_option,
 141                 Evoral::Beats                                    when = Evoral::Beats());
 142
 143         virtual void session_saved();
 144
 145         std::string captured_for() const               { return _captured_for; }
 146         void        set_captured_for (std::string str) { _captured_for = str; }
 147
 148         static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
 149
 150         XMLNode& get_state ();
 151         int set_state (const XMLNode&, int version);
 152
 153         bool length_mutable() const { return true; }
 154
 155         void     set_length_beats(TimeType l) { _length_beats = l; }
 156         TimeType length_beats() const         { return _length_beats; }
 157
 158         virtual void load_model(const Glib::Threads::Mutex::Lock& lock, bool force_reload=false) = 0;
 159         virtual void destroy_model(const Glib::Threads::Mutex::Lock& lock) = 0;
 160
 161         /** Reset cached information (like iterators) when things have changed.
 162          * @param lock Source lock, which must be held by caller.
 163          * @param notes If non-NULL, currently active notes are added to this set.
 164          */
 165         void invalidate(const Glib::Threads::Mutex::Lock&                       lock,
 166                         std::set<Evoral::Sequence<Evoral::Beats>::WeakNotePtr>* notes=NULL);
 167
 168         void set_note_mode(const Glib::Threads::Mutex::Lock& lock, NoteMode mode);
 169
 170         boost::shared_ptr<MidiModel> model() { return _model; }
 171         void set_model(const Glib::Threads::Mutex::Lock& lock, boost::shared_ptr<MidiModel>);
 172         void drop_model(const Glib::Threads::Mutex::Lock& lock);
 173
 174         Evoral::ControlList::InterpolationStyle interpolation_of (Evoral::Parameter) const;
 175         void set_interpolation_of (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
 176         void copy_interpolation_from (boost::shared_ptr<MidiSource>);
 177         void copy_interpolation_from (MidiSource *);
 178
 179         AutoState automation_state_of (Evoral::Parameter) const;
 180         void set_automation_state_of (Evoral::Parameter, AutoState);
 181         void copy_automation_state_from (boost::shared_ptr<MidiSource>);
 182         void copy_automation_state_from (MidiSource *);
 183
 184         /** Emitted when a different MidiModel is set */
 185         PBD::Signal0<void> ModelChanged;
 186         /** Emitted when a parameter's interpolation style is changed */
 187         PBD::Signal2<void, Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationChanged;
 188         /** Emitted when a parameter's automation state is changed */
 189         PBD::Signal2<void, Evoral::Parameter, AutoState> AutomationStateChanged;
 190
 191   protected:
 192         virtual void flush_midi(const Lock& lock) = 0;
 193
 194         virtual framecnt_t read_unlocked (const Lock&                    lock,
 195                                           Evoral::EventSink<framepos_t>& dst,
 196                                           framepos_t                     position,
 197                                           framepos_t                     start,
 198                                           framecnt_t                     cnt,
 199                                           MidiStateTracker*              tracker,
 200                                           MidiChannelFilter*             filter) const = 0;
 201
 202         /** Write data to this source from a MidiRingBuffer.
 203          *  @param source Buffer to read from.
 204          *  @param position This source's start position in session frames.
 205          *  @param cnt The duration of this block to write for.
 206          */
 207         virtual framecnt_t write_unlocked (const Lock&                 lock,
 208                                            MidiRingBuffer<framepos_t>& source,
 209                                            framepos_t                  position,
 210                                            framecnt_t                  cnt) = 0;
 211
 212         std::string _captured_for;
 213
 214         boost::shared_ptr<MidiModel> _model;
 215         bool                         _writing;
 216
 217         mutable Evoral::Sequence<Evoral::Beats>::const_iterator _model_iter;
 218         mutable bool                                            _model_iter_valid;
 219
 220         mutable Evoral::Beats _length_beats;
 221         mutable framepos_t    _last_read_end;
 222
 223         /** The total duration of the current capture. */
 224         framepos_t _capture_length;
 225
 226         /** Length of transport loop during current capture, or zero. */
 227         framepos_t _capture_loop_length;
 228
 229         /** Map of interpolation styles to use for Parameters; if they are not in this map,
 230          *  the correct interpolation style can be obtained from EventTypeMap::interpolation_of ()
 231          */
 232         typedef std::map<Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationStyleMap;
 233         InterpolationStyleMap _interpolation_style;
 234
 235         /** Map of automation states to use for Parameters; if they are not in this map,
 236          *  the correct automation state is Off.
 237          */
 238         typedef std::map<Evoral::Parameter, AutoState> AutomationStateMap;
 239         AutomationStateMap  _automation_state;
 240 };
 241
 242 }
 243
 244 #endif /* __ardour_midi_source_h__ */