/*
- Copyright (C) 2006 Paul Davis
- Written by Dave Robillard, 2006
+ Copyright (C) 2006 Paul Davis
+ Author: David Robillard
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#define __ardour_midi_source_h__
#include <string>
-
#include <time.h>
-
#include <glibmm/thread.h>
-
-#include <sigc++/signal.h>
-
-#include <ardour/source.h>
-#include <ardour/ardour.h>
-#include <pbd/stateful.h>
-#include <pbd/xml++.h>
-
-using std::string;
+#include <boost/enable_shared_from_this.hpp>
+#include "pbd/stateful.h"
+#include "pbd/xml++.h"
+#include "evoral/Sequence.hpp"
+#include "ardour/ardour.h"
+#include "ardour/buffer.h"
+#include "ardour/source.h"
+#include "ardour/beats_frames_converter.h"
namespace ARDOUR {
-/** Source for raw MIDI data */
-class MidiSource : public Source
+class MidiStateTracker;
+class MidiModel;
+template<typename T> class MidiRingBuffer;
+
+/** Source for MIDI data */
+class MidiSource : virtual public Source, public boost::enable_shared_from_this<MidiSource>
{
public:
- MidiSource (string name);
- MidiSource (const XMLNode&);
+ typedef double TimeType;
+
+ MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
+ MidiSource (Session& session, const XMLNode&);
virtual ~MidiSource ();
- /* returns the number of items in this `midi_source' */
+ boost::shared_ptr<MidiSource> clone (Evoral::MusicalTime begin = Evoral::MinMusicalTime,
+ Evoral::MusicalTime end = Evoral::MaxMusicalTime);
+
+ /** Read the data in a given time range from the MIDI source.
+ * All time stamps in parameters are in audio frames (even if the source has tempo time).
+ * \param dst Ring buffer where read events are written
+ * \param source_start Start position of the SOURCE in this read context
+ * \param start Start of range to be read
+ * \param cnt Length of range to be read (in audio frames)
+ * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking
+ */
+ virtual framecnt_t midi_read (Evoral::EventSink<framepos_t>& dst,
+ framepos_t source_start,
+ framepos_t start, framecnt_t cnt,
+ MidiStateTracker*,
+ std::set<Evoral::Parameter> const &) const;
+
+ virtual framecnt_t midi_write (MidiRingBuffer<framepos_t>& src,
+ framepos_t source_start,
+ framecnt_t cnt);
+
+ virtual void append_event_unlocked_beats(const Evoral::Event<Evoral::MusicalTime>& ev) = 0;
+
+ virtual void append_event_unlocked_frames(const Evoral::Event<framepos_t>& ev,
+ framepos_t source_start) = 0;
+
+ virtual bool empty () const;
+ virtual framecnt_t length (framepos_t pos) const;
+ virtual void update_length (framepos_t pos, framecnt_t cnt);
+
+ virtual void mark_streaming_midi_write_started (NoteMode mode);
+ virtual void mark_streaming_write_started ();
+ virtual void mark_streaming_write_completed ();
+ void mark_write_starting_now ();
+
+ /* like ::mark_streaming_write_completed() but with more arguments to
+ * allow control over MIDI-specific behaviour. Expected to be used only
+ * when recording actual MIDI input, rather then when importing files
+ * etc.
+ */
+ virtual void mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption, Evoral::MusicalTime when = 0);
+
+ virtual void session_saved();
+
+ std::string captured_for() const { return _captured_for; }
+ void set_captured_for (std::string str) { _captured_for = str; }
+
+ uint32_t read_data_count() const { return _read_data_count; }
+ uint32_t write_data_count() const { return _write_data_count; }
+
+ framepos_t last_write_end() const { return _last_write_end; }
+ void set_last_write_end (framepos_t pos) { _last_write_end = pos; }
- // Applicable to MIDI? With what unit? [DR]
- virtual jack_nframes_t length() const {
- return _length;
- }
+ static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
- virtual jack_nframes_t read (unsigned char *dst, jack_nframes_t start, jack_nframes_t cnt, char * workbuf) const;
- virtual jack_nframes_t write (unsigned char *src, jack_nframes_t cnt, char * workbuf);
+ XMLNode& get_state ();
+ int set_state (const XMLNode&, int version);
- virtual void mark_for_remove() = 0;
- virtual void mark_streaming_write_completed () {}
+ bool length_mutable() const { return true; }
- void set_captured_for (string str) { _captured_for = str; }
- string captured_for() const { return _captured_for; }
+ void set_length_beats(double l) { _length_beats = l; }
+ double length_beats() const { return _length_beats; }
- uint32_t read_data_count() const { return _read_data_count; }
- uint32_t write_data_count() const { return _write_data_count; }
+ virtual void load_model(bool lock=true, bool force_reload=false) = 0;
+ virtual void destroy_model() = 0;
- static sigc::signal<void,MidiSource*> MidiSourceCreated;
-
- mutable sigc::signal<void> PeaksReady;
- mutable sigc::signal<void,jack_nframes_t,jack_nframes_t> PeakRangeReady;
-
- XMLNode& get_state ();
- int set_state (const XMLNode&);
+ /** This must be called with the source lock held whenever the
+ * source/model contents have been changed (reset iterators/cache/etc).
+ */
+ void invalidate();
- protected:
- jack_nframes_t _length;
- string _captured_for;
+ void set_note_mode(NoteMode mode);
+
+ boost::shared_ptr<MidiModel> model() { return _model; }
+ void set_model (boost::shared_ptr<MidiModel>);
+ void drop_model();
- mutable uint32_t _read_data_count; // modified in read()
- mutable uint32_t _write_data_count; // modified in write()
+ Evoral::ControlList::InterpolationStyle interpolation_of (Evoral::Parameter) const;
+ void set_interpolation_of (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
+ void copy_interpolation_from (boost::shared_ptr<MidiSource>);
+ void copy_interpolation_from (MidiSource *);
- virtual jack_nframes_t read_unlocked (unsigned char *dst, jack_nframes_t start, jack_nframes_t cnt, char * workbuf) const = 0;
- virtual jack_nframes_t write_unlocked (unsigned char *dst, jack_nframes_t cnt, char * workbuf) = 0;
-
- void update_length (jack_nframes_t pos, jack_nframes_t cnt);
+ AutoState automation_state_of (Evoral::Parameter) const;
+ void set_automation_state_of (Evoral::Parameter, AutoState);
+ void copy_automation_state_from (boost::shared_ptr<MidiSource>);
+ void copy_automation_state_from (MidiSource *);
- private:
- bool file_changed (string path);
+ /** Emitted when a different MidiModel is set */
+ PBD::Signal0<void> ModelChanged;
+ /** Emitted when a parameter's interpolation style is changed */
+ PBD::Signal2<void, Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationChanged;
+ /** Emitted when a parameter's automation state is changed */
+ PBD::Signal2<void, Evoral::Parameter, AutoState> AutomationStateChanged;
+
+ protected:
+ virtual void flush_midi() = 0;
+
+ virtual framepos_t read_unlocked (Evoral::EventSink<framepos_t>& dst,
+ framepos_t position,
+ framepos_t start, framecnt_t cnt,
+ MidiStateTracker* tracker) const = 0;
+
+ virtual framepos_t write_unlocked (MidiRingBuffer<framepos_t>& dst,
+ framepos_t position,
+ framecnt_t cnt) = 0;
+
+ std::string _captured_for;
+ mutable uint32_t _read_data_count; ///< modified in read()
+ mutable uint32_t _write_data_count; ///< modified in write()
+
+ boost::shared_ptr<MidiModel> _model;
+ bool _writing;
+
+ mutable Evoral::Sequence<Evoral::MusicalTime>::const_iterator _model_iter;
+ mutable bool _model_iter_valid;
+
+ mutable double _length_beats;
+ mutable framepos_t _last_read_end;
+ framepos_t _last_write_end;
+
+ /** Map of interpolation styles to use for Parameters; if they are not in this map,
+ * the correct interpolation style can be obtained from EventTypeMap::interpolation_of ()
+ */
+ typedef std::map<Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationStyleMap;
+ InterpolationStyleMap _interpolation_style;
+
+ /** Map of automation states to use for Parameters; if they are not in this map,
+ * the correct automation state is Off.
+ */
+ typedef std::map<Evoral::Parameter, AutoState> AutomationStateMap;
+ AutomationStateMap _automation_state;
};
}