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