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/thread.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 template<typename T> class MidiRingBuffer;
  40
  41 /** Source for MIDI data */
  42 class MidiSource : virtual public Source, public boost::enable_shared_from_this<MidiSource>
  43 {
  44   public:
  45         typedef double TimeType;
  46
  47         MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
  48         MidiSource (Session& session, const XMLNode&);
  49         virtual ~MidiSource ();
  50
  51         boost::shared_ptr<MidiSource> clone (const std::string& path,
  52                                              Evoral::MusicalTime begin = Evoral::MinMusicalTime,
  53                                              Evoral::MusicalTime end = Evoral::MaxMusicalTime);
  54
  55         /** Read the data in a given time range from the MIDI source.
  56          * All time stamps in parameters are in audio frames (even if the source has tempo time).
  57          * \param dst Ring buffer where read events are written
  58          * \param source_start Start position of the SOURCE in this read context
  59          * \param start Start of range to be read
  60          * \param cnt Length of range to be read (in audio frames)
  61          * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking
  62          */
  63         virtual framecnt_t midi_read (Evoral::EventSink<framepos_t>& dst,
  64                                       framepos_t source_start,
  65                                       framepos_t start, framecnt_t cnt,
  66                                       MidiStateTracker*,
  67                                       std::set<Evoral::Parameter> const &) const;
  68
  69         virtual framecnt_t midi_write (MidiRingBuffer<framepos_t>& src,
  70                                        framepos_t source_start,
  71                                        framecnt_t cnt);
  72
  73         virtual void append_event_unlocked_beats(const Evoral::Event<Evoral::MusicalTime>& ev) = 0;
  74
  75         virtual void append_event_unlocked_frames(const Evoral::Event<framepos_t>& ev,
  76                         framepos_t source_start) = 0;
  77
  78         virtual bool       empty () const;
  79         virtual framecnt_t length (framepos_t pos) const;
  80         virtual void       update_length (framecnt_t);
  81
  82         virtual void mark_streaming_midi_write_started (NoteMode mode);
  83         virtual void mark_streaming_write_started ();
  84         virtual void mark_streaming_write_completed ();
  85         void mark_write_starting_now ();
  86
  87         /* like ::mark_streaming_write_completed() but with more arguments to
  88          * allow control over MIDI-specific behaviour. Expected to be used only
  89          * when recording actual MIDI input, rather then when importing files
  90          * etc.
  91          */
  92         virtual void mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption, Evoral::MusicalTime when = 0);
  93
  94         virtual void session_saved();
  95
  96         std::string captured_for() const               { return _captured_for; }
  97         void        set_captured_for (std::string str) { _captured_for = str; }
  98
  99         framepos_t last_write_end() const { return _last_write_end; }
 100         void set_last_write_end (framepos_t pos) { _last_write_end = pos; }
 101
 102         static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
 103
 104         XMLNode& get_state ();
 105         int set_state (const XMLNode&, int version);
 106
 107         bool length_mutable() const { return true; }
 108
 109         void set_length_beats(double l) { _length_beats = l; }
 110         double length_beats() const { return _length_beats; }
 111
 112         virtual void load_model(bool lock=true, bool force_reload=false) = 0;
 113         virtual void destroy_model() = 0;
 114
 115         /** This must be called with the source lock held whenever the
 116          *  source/model contents have been changed (reset iterators/cache/etc).
 117          */
 118         void invalidate();
 119
 120         void set_note_mode(NoteMode mode);
 121
 122         boost::shared_ptr<MidiModel> model() { return _model; }
 123         void set_model (boost::shared_ptr<MidiModel>);
 124         void drop_model();
 125
 126         Evoral::ControlList::InterpolationStyle interpolation_of (Evoral::Parameter) const;
 127         void set_interpolation_of (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
 128         void copy_interpolation_from (boost::shared_ptr<MidiSource>);
 129         void copy_interpolation_from (MidiSource *);
 130
 131         AutoState automation_state_of (Evoral::Parameter) const;
 132         void set_automation_state_of (Evoral::Parameter, AutoState);
 133         void copy_automation_state_from (boost::shared_ptr<MidiSource>);
 134         void copy_automation_state_from (MidiSource *);
 135
 136         /** Emitted when a different MidiModel is set */
 137         PBD::Signal0<void> ModelChanged;
 138         /** Emitted when a parameter's interpolation style is changed */
 139         PBD::Signal2<void, Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationChanged;
 140         /** Emitted when a parameter's automation state is changed */
 141         PBD::Signal2<void, Evoral::Parameter, AutoState> AutomationStateChanged;
 142
 143   protected:
 144         virtual void flush_midi() = 0;
 145
 146         virtual framecnt_t read_unlocked (Evoral::EventSink<framepos_t>& dst,
 147                                           framepos_t position,
 148                                           framepos_t start, framecnt_t cnt,
 149                                           MidiStateTracker* tracker) const = 0;
 150
 151         virtual framecnt_t write_unlocked (MidiRingBuffer<framepos_t>& dst,
 152                                            framepos_t position,
 153                                            framecnt_t cnt) = 0;
 154
 155         std::string      _captured_for;
 156
 157         boost::shared_ptr<MidiModel> _model;
 158         bool                         _writing;
 159
 160         mutable Evoral::Sequence<Evoral::MusicalTime>::const_iterator _model_iter;
 161         mutable bool                                                  _model_iter_valid;
 162
 163         mutable double     _length_beats;
 164         mutable framepos_t _last_read_end;
 165         framepos_t         _last_write_end;
 166
 167         /** Map of interpolation styles to use for Parameters; if they are not in this map,
 168          *  the correct interpolation style can be obtained from EventTypeMap::interpolation_of ()
 169          */
 170         typedef std::map<Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationStyleMap;
 171         InterpolationStyleMap _interpolation_style;
 172
 173         /** Map of automation states to use for Parameters; if they are not in this map,
 174          *  the correct automation state is Off.
 175          */
 176         typedef std::map<Evoral::Parameter, AutoState> AutomationStateMap;
 177         AutomationStateMap  _automation_state;
 178 };
 179
 180 }
 181
 182 #endif /* __ardour_midi_source_h__ */