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.
21 #ifndef __ardour_smf_filesource_h__
22 #define __ardour_smf_filesource_h__
27 #include <ardour/midi_source.h>
33 /** Standard Midi File (Type 0) Source */
34 class SMFSource : public MidiSource {
41 RemovableIfEmpty = 0x10,
42 RemoveAtDestroy = 0x20,
46 /** Constructor for existing external-to-session files */
47 SMFSource (Session& session, std::string path, Flag flags = Flag(0));
49 /* Constructor for existing in-session files */
50 SMFSource (Session& session, const XMLNode&);
52 virtual ~SMFSource ();
54 /* this block of methods do nothing for regular file sources, but are significant
55 for files used in destructive recording.
57 // FIXME and thus are useless for MIDI.. but make MidiDiskstream compile easier! :)
59 virtual nframes_t last_capture_start_frame() const { return 0; }
60 virtual void mark_capture_start (nframes_t) {}
61 virtual void mark_capture_end () {}
62 virtual void clear_capture_marks() {}
64 bool set_name (const std::string& newname) { return (set_source_name(newname, false) == 0); }
65 int set_source_name (string newname, bool destructive);
67 static bool safe_file_extension (const Glib::ustring& path);
69 Glib::ustring path() const { return _path; }
71 void set_allow_remove_if_empty (bool yn);
72 void mark_for_remove();
74 void append_event_unlocked(EventTimeUnit unit, const MIDI::Event& ev);
79 int move_to_trash (const string trash_dir_name);
81 bool is_empty () const;
82 void mark_streaming_midi_write_started (NoteMode mode, nframes_t start_time);
83 void mark_streaming_write_completed ();
85 void mark_take (string);
86 string take_id() const { return _take_id; }
88 static void set_search_path (string);
89 static void set_header_position_offset (nframes_t offset, bool negative);
91 XMLNode& get_state ();
92 int set_state (const XMLNode&);
94 void seek_to(nframes_t time);
96 void load_model(bool lock=true, bool force_reload=false);
99 uint16_t ppqn() const { return _ppqn; }
103 int init (string idstr, bool must_exist);
105 nframes_t read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cn, nframes_t stamp_offset, nframes_t negative_stamp_offset) const;
106 nframes_t write_unlocked (MidiRingBuffer& dst, nframes_t cnt);
108 bool find (std::string path, bool must_exist, bool& is_new);
109 bool removable() const;
110 bool writable() const { return _flags & Writable; }
117 void write_chunk_header(const char id[4], uint32_t length);
118 void write_chunk(const char id[4], uint32_t length, void* data);
119 size_t write_var_len(uint32_t val);
120 uint32_t read_var_len() const;
121 int read_event(uint32_t* delta_t, uint32_t* size, Byte** buf) const;
123 static const uint16_t _ppqn = 19200;
128 bool _allow_remove_if_empty;
130 double _last_ev_time; // last frame time written, relative to source start
131 uint32_t _track_size;
132 uint32_t _header_size; // size of SMF header, including MTrk chunk header
134 static string _search_path;
137 }; /* namespace ARDOUR */
139 #endif /* __ardour_smf_filesource_h__ */