2 Copyright (C) 2006 Paul Davis
3 Author: David Robillard
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.
21 #ifndef __ardour_smf_source_h__
22 #define __ardour_smf_source_h__
26 #include "evoral/SMF.hpp"
27 #include "ardour/midi_source.h"
28 #include "ardour/file_source.h"
30 namespace Evoral { template<typename T> class Event; }
34 template<typename T> class MidiRingBuffer;
36 /** Standard Midi File (Type 0) Source */
37 class LIBARDOUR_API SMFSource : public MidiSource, public FileSource, public Evoral::SMF {
39 /** Constructor for new internal-to-session files */
40 SMFSource (Session& session, const std::string& path, Source::Flag flags);
42 /** Constructor for existing external-to-session files */
43 SMFSource (Session& session, const std::string& path);
45 /** Constructor for existing in-session files */
46 SMFSource (Session& session, const XMLNode&, bool must_exist = false);
48 virtual ~SMFSource ();
50 bool safe_file_extension (const std::string& path) const {
51 return safe_midi_file_extension(path);
54 void append_event_beats (const Lock& lock, const Evoral::Event<Temporal::Beats>& ev);
55 void append_event_samples (const Lock& lock, const Evoral::Event<samplepos_t>& ev, samplepos_t source_start);
57 void mark_streaming_midi_write_started (const Lock& lock, NoteMode mode);
58 void mark_streaming_write_completed (const Lock& lock);
59 void mark_midi_streaming_write_completed (const Lock& lock,
60 Evoral::Sequence<Temporal::Beats>::StuckNoteOption,
61 Temporal::Beats when = Temporal::Beats());
63 XMLNode& get_state ();
64 int set_state (const XMLNode&, int version);
66 void load_model (const Glib::Threads::Mutex::Lock& lock, bool force_reload=false);
67 void destroy_model (const Glib::Threads::Mutex::Lock& lock);
69 static bool safe_midi_file_extension (const std::string& path);
70 static bool valid_midi_file (const std::string& path);
72 void prevent_deletion ();
73 void set_path (const std::string& newpath);
77 void flush_midi (const Lock& lock);
81 Temporal::Beats _last_ev_time_beats;
82 samplepos_t _last_ev_time_samples;
83 /** end time (start + duration) of last call to read_unlocked */
84 mutable samplepos_t _smf_last_read_end;
85 /** time (in SMF ticks, 1 tick per _ppqn) of the last event read by read_unlocked */
86 mutable samplepos_t _smf_last_read_time;
88 int open_for_write ();
90 void ensure_disk_file (const Lock& lock);
92 samplecnt_t read_unlocked (const Lock& lock,
93 Evoral::EventSink<samplepos_t>& dst,
97 Evoral::Range<samplepos_t>* loop_range,
98 MidiStateTracker* tracker,
99 MidiChannelFilter* filter) const;
101 samplecnt_t write_unlocked (const Lock& lock,
102 MidiRingBuffer<samplepos_t>& src,
103 samplepos_t position,
108 }; /* namespace ARDOUR */
110 #endif /* __ardour_smf_source_h__ */