2 Copyright (C) 2006 Paul Davis
3 Written by Dave Robillard, 2006
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.
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.
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.
20 #ifndef __ardour_midi_source_h__
21 #define __ardour_midi_source_h__
25 #include <sigc++/signal.h>
26 #include <glibmm/thread.h>
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>
39 template<typename T> class MidiRingBuffer;
41 /** Source for MIDI data */
42 class MidiSource : public Source
45 typedef double TimeType;
47 MidiSource (Session& session, string name);
48 MidiSource (Session& session, const XMLNode&);
49 virtual ~MidiSource ();
51 /* Stub Readable interface */
52 virtual nframes64_t read (Sample*, nframes64_t pos, nframes64_t cnt, int channel) const { return 0; }
53 virtual nframes64_t readable_length() const { return length(); }
54 virtual uint32_t n_channels () const { return 1; }
56 // FIXME: integrate this with the Readable::read interface somehow
57 virtual nframes_t midi_read (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t cnt,
58 nframes_t stamp_offset, nframes_t negative_stamp_offset) const;
59 virtual nframes_t midi_write (MidiRingBuffer<nframes_t>& src, nframes_t cnt);
61 virtual void append_event_unlocked_beats(const Evoral::Event<double>& ev) = 0;
62 virtual void append_event_unlocked_frames(const Evoral::Event<nframes_t>& ev) = 0;
64 virtual void mark_for_remove() = 0;
65 virtual void mark_streaming_midi_write_started (NoteMode mode, nframes_t start_time);
66 virtual void mark_streaming_write_started ();
67 virtual void mark_streaming_write_completed ();
69 uint64_t timeline_position () { return _timeline_position; }
70 void set_timeline_position (nframes_t when) { _timeline_position = when; }
72 virtual void session_saved();
74 string captured_for() const { return _captured_for; }
75 void set_captured_for (string str) { _captured_for = str; }
77 uint32_t read_data_count() const { return _read_data_count; }
78 uint32_t write_data_count() const { return _write_data_count; }
80 static sigc::signal<void,MidiSource*> MidiSourceCreated;
82 // Signal a range of recorded data is available for reading from model()
83 mutable sigc::signal<void,nframes_t,nframes_t> ViewDataRangeReady;
85 XMLNode& get_state ();
86 int set_state (const XMLNode&);
88 bool length_mutable() const { return true; }
90 virtual void load_model(bool lock=true, bool force_reload=false) = 0;
91 virtual void destroy_model() = 0;
93 void set_note_mode(NoteMode mode);
95 boost::shared_ptr<MidiModel> model() { return _model; }
96 void set_model(boost::shared_ptr<MidiModel> m) { _model = m; }
97 void drop_model() { _model.reset(); }
100 virtual void flush_midi() = 0;
102 virtual nframes_t read_unlocked (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t cnt,
103 nframes_t stamp_offset, nframes_t negative_stamp_offset) const = 0;
104 virtual nframes_t write_unlocked (MidiRingBuffer<nframes_t>& dst, nframes_t cnt) = 0;
106 mutable Glib::Mutex _lock;
107 string _captured_for;
108 uint64_t _timeline_position;
109 mutable uint32_t _read_data_count; ///< modified in read()
110 mutable uint32_t _write_data_count; ///< modified in write()
112 boost::shared_ptr<MidiModel> _model;
115 mutable Evoral::Sequence<double>::const_iterator _model_iter;
116 mutable nframes_t _last_read_end;
119 bool file_changed (string path);
124 #endif /* __ardour_midi_source_h__ */