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.
28 #include <pbd/mountpoint.h>
29 #include <pbd/pathscanner.h>
30 #include <pbd/stl_delete.h>
31 #include <pbd/strsplit.h>
33 #include <glibmm/miscutils.h>
35 #include <ardour/smf_source.h>
36 #include <ardour/session.h>
37 #include <ardour/midi_ring_buffer.h>
38 #include <ardour/midi_util.h>
39 #include <ardour/tempo.h>
40 #include <ardour/audioengine.h>
44 using namespace ARDOUR;
46 string SMFSource::_search_path;
48 /*sigc::signal<void,struct tm*, time_t> SMFSource::HeaderPositionOffsetChanged;
49 bool SMFSource::header_position_negative;
50 uint64_t SMFSource::header_position_offset;
53 SMFSource::SMFSource (Session& s, std::string path, Flag flags)
54 : MidiSource (s, region_name_from_path(path, false))
56 , _flags (Flag(flags | Writable)) // FIXME: this needs to be writable for now
57 , _allow_remove_if_empty(true)
60 , _track_size(4) // 4 bytes for the ever-present EOT event
63 /* constructor used for new internal-to-session files. file cannot exist */
65 if (init (path, false)) {
66 throw failed_constructor ();
70 throw failed_constructor ();
73 cerr << "SMF Source path: " << path << endl;
75 assert(_name.find("/") == string::npos);
78 SMFSource::SMFSource (Session& s, const XMLNode& node)
79 : MidiSource (s, node)
81 , _flags (Flag (Writable|CanRename))
82 , _allow_remove_if_empty(true)
85 , _track_size(4) // 4 bytes for the ever-present EOT event
88 /* constructor used for existing internal-to-session files. file must exist */
90 if (set_state (node)) {
91 throw failed_constructor ();
94 if (init (_name, true)) {
95 throw failed_constructor ();
99 throw failed_constructor ();
102 cerr << "SMF Source name: " << _name << endl;
104 assert(_name.find("/") == string::npos);
107 SMFSource::~SMFSource ()
110 unlink (_path.c_str());
115 SMFSource::removable () const
117 return (_flags & Removable) && ((_flags & RemoveAtDestroy) ||
118 ((_flags & RemovableIfEmpty) && is_empty()));
122 SMFSource::init (string pathstr, bool must_exist)
126 if (!find (pathstr, must_exist, is_new)) {
127 cerr << "cannot find " << pathstr << " with me = " << must_exist << endl;
131 if (is_new && must_exist) {
135 assert(_name.find("/") == string::npos);
142 //cerr << "Opening SMF file " << path() << " writeable: " << writable() << endl;
144 assert(writable()); // FIXME;
146 _fd = fopen(path().c_str(), "r+");
148 // File already exists
150 fseek(_fd, _header_size - 4, 0);
151 uint32_t track_size_be = 0;
152 fread(&track_size_be, 4, 1, _fd);
153 _track_size = GUINT32_FROM_BE(track_size_be);
154 //cerr << "SMF - read track size " << _track_size << endl;
156 // We're making a new file
158 _fd = fopen(path().c_str(), "w+");
161 // Write a tentative header just to pad things out so writing happens in the right spot
162 set_timeline_position(0);
165 // Note file isn't a valid SMF at this point (no footer). Does it matter?
168 return (_fd == 0) ? -1 : 0;
172 SMFSource::flush_header ()
174 // FIXME: write timeline position somehow?
176 //cerr << "SMF Flushing header\n";
180 const uint16_t type = GUINT16_TO_BE(0); // SMF Type 0 (single track)
181 const uint16_t ntracks = GUINT16_TO_BE(1); // Number of tracks (always 1 for Type 0)
182 const uint16_t division = GUINT16_TO_BE(_ppqn); // Pulses per beat
185 memcpy(data, &type, 2);
186 memcpy(data+2, &ntracks, 2);
187 memcpy(data+4, &division, 2);
189 _fd = freopen(path().c_str(), "r+", _fd);
192 write_chunk("MThd", 6, data);
193 //if (_track_size > 0) {
194 write_chunk_header("MTrk", _track_size);
203 SMFSource::flush_footer()
205 cerr << "SMF " << name() << " writing EOT\n";
207 fseek(_fd, 0, SEEK_END);
209 char eot[3] = { 0xFF, 0x2F, 0x00 }; // end-of-track meta-event
210 fwrite(eot, 1, 3, _fd);
215 /** Returns the offset of the first event in the file with a time past @a start,
216 * relative to the start of the source.
218 * Returns -1 if not found.
222 SMFSource::find_first_event_after(nframes_t start)
224 // FIXME: obviously this is slooow
226 fseek(_fd, _header_size, 0);
228 while ( ! feof(_fd) ) {
229 const uint32_t delta_time = read_var_len();
231 if (delta_time > start)
239 /** Read an event from the current position in file.
241 * File position MUST be at the beginning of a delta time, or this will die very messily.
242 * ev.buffer must be of size ev.size, and large enough for the event. The returned event
243 * will have it's time field set to it's delta time, in SMF tempo-based ticks, using the
244 * rate given by ppqn() (it is the caller's responsibility to calculate a real time).
246 * Returns event length (including status byte) on success, 0 if event was
247 * skipped (eg a meta event), or -1 on EOF (or end of track).
250 SMFSource::read_event(jack_midi_event_t& ev) const
252 // - 4 is for the EOT event, which we don't actually want to read
253 //if (feof(_fd) || ftell(_fd) >= _header_size + _track_size - 4) {
258 uint32_t delta_time = read_var_len();
260 int status = fgetc(_fd);
261 assert(status != EOF); // FIXME die gracefully
262 if (status == 0xFF) {
264 int type = fgetc(_fd);
265 if ((unsigned char)type == 0x2F) {
266 //cerr << "SMF - hit EOT" << endl;
267 return -1; // we hit the logical EOF anyway...
270 ev.time = delta_time; // this is needed regardless
275 size_t event_size = midi_event_size((unsigned char)status) + 1;
277 // Make sure we have enough scratch buffer
278 if (ev.size < event_size)
279 ev.buffer = (Byte*)realloc(ev.buffer, event_size);
281 ev.time = delta_time;
282 ev.size = event_size;
284 /*if (ev.buffer == NULL)
285 ev.buffer = (Byte*)malloc(sizeof(Byte) * ev.size);*/
287 ev.buffer[0] = (unsigned char)status;
288 fread(ev.buffer+1, 1, ev.size - 1, _fd);
290 /*printf("%s read event: delta = %u, size = %zu, data = ", _name.c_str(), delta_time, ev.size);
291 for (size_t i=0; i < ev.size; ++i) {
292 printf("%X ", ev.buffer[i]);
299 /** All stamps in audio frames */
301 SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset) const
303 //cerr << "SMF - read " << start << ", count=" << cnt << ", offset=" << stamp_offset << endl;
305 // 64 bits ought to be enough for anybody
306 uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
308 _read_data_count = 0;
310 jack_midi_event_t ev; // time in SMF ticks
313 ev.buffer = NULL; // read_event will allocate scratch as needed
315 size_t scratch_size = 0; // keep track of scratch and minimize reallocs
317 // FIXME: don't seek to start every read
318 fseek(_fd, _header_size, 0);
320 // FIXME: assumes tempo never changes after start
321 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
322 _session.engine().frame_rate());
324 uint64_t start_ticks = (uint64_t)((start / frames_per_beat) * _ppqn);
327 int ret = read_event(ev);
328 if (ret == -1) { // EOF
329 //cerr << "SMF - EOF\n";
333 if (ret == 0) { // meta-event (skipped)
334 //cerr << "SMF - META\n";
335 time += ev.time; // just accumulate delta time and ignore event
339 time += ev.time; // accumulate delta time
340 ev.time = time; // set ev.time to actual time (relative to source start)
342 if (ev.time >= start_ticks) {
343 if (ev.time < start_ticks + (cnt / frames_per_beat)) {
346 ev.time = (nframes_t)(((ev.time / (double)_ppqn) * frames_per_beat)) + stamp_offset;
347 // write event time in absolute frames
348 dst.write(ev.time, ev.size, ev.buffer);
352 _read_data_count += ev.size;
354 if (ev.size > scratch_size)
355 scratch_size = ev.size;
357 ev.size = scratch_size;
363 /** All stamps in audio frames */
365 SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
367 _write_data_count = 0;
369 boost::shared_ptr<MidiBuffer> buf_ptr(new MidiBuffer(1024)); // FIXME: size?
370 MidiBuffer& buf = *buf_ptr.get();
371 src.read(buf, /*_length*/0, _length + cnt); // FIXME?
373 fseek(_fd, 0, SEEK_END);
375 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
377 assert(ev.time() >= _timeline_position);
378 ev.time() -= _timeline_position;
379 assert(ev.time() >= _last_ev_time);
381 append_event_unlocked(ev);
386 const nframes_t oldlen = _length;
387 update_length(oldlen, cnt);
390 if ( ! _model->currently_writing()) {
391 _model->start_write();
396 ViewDataRangeReady (buf_ptr, oldlen, cnt); /* EMIT SIGNAL */
403 SMFSource::append_event_unlocked(const MidiEvent& ev)
405 printf("SMF - writing event, time = %lf, size = %u, data = ", ev.time(), ev.size());
406 for (size_t i=0; i < ev.size(); ++i) {
407 printf("%X ", ev.buffer()[i]);
411 assert(ev.time() >= _last_ev_time);
413 // FIXME: assumes tempo never changes after start
414 const double frames_per_beat = _session.tempo_map().tempo_at
415 (_timeline_position).frames_per_beat(_session.engine().frame_rate());
417 const uint32_t delta_time = (uint32_t)((ev.time() - _last_ev_time) / frames_per_beat * _ppqn);
419 const size_t stamp_size = write_var_len(delta_time);
420 fwrite(ev.buffer(), 1, ev.size(), _fd);
422 _track_size += stamp_size + ev.size();
423 _write_data_count += ev.size();
425 _last_ev_time = ev.time();
430 SMFSource::get_state ()
432 XMLNode& root (MidiSource::get_state());
434 snprintf (buf, sizeof (buf), "0x%x", (int)_flags);
435 root.add_property ("flags", buf);
440 SMFSource::set_state (const XMLNode& node)
442 const XMLProperty* prop;
444 if (MidiSource::set_state (node)) {
448 if ((prop = node.property (X_("flags"))) != 0) {
451 sscanf (prop->value().c_str(), "0x%x", &ival);
452 _flags = Flag (ival);
460 assert(_name.find("/") == string::npos);
466 SMFSource::mark_for_remove ()
471 _flags = Flag (_flags | RemoveAtDestroy);
475 SMFSource::mark_streaming_write_completed ()
477 MidiSource::mark_streaming_write_completed();
486 Glib::Mutex::Lock lm (_lock);
489 next_peak_clear_should_notify = true;
491 if (_peaks_built || pending_peak_builds.empty()) {
493 PeaksReady (); /* EMIT SIGNAL */
499 SMFSource::mark_take (string id)
507 SMFSource::move_to_trash (const string trash_dir_name)
515 /* don't move the file across filesystems, just
516 stick it in the 'trash_dir_name' directory
517 on whichever filesystem it was already on.
520 newpath = Glib::path_get_dirname (_path);
521 newpath = Glib::path_get_dirname (newpath);
524 newpath += trash_dir_name;
526 newpath += Glib::path_get_basename (_path);
528 if (access (newpath.c_str(), F_OK) == 0) {
530 /* the new path already exists, try versioning */
532 char buf[PATH_MAX+1];
536 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
539 while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
540 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
544 if (version == 999) {
545 PBD::error << string_compose (_("there are already 1000 files with names like %1; versioning discontinued"),
554 /* it doesn't exist, or we can't read it or something */
558 if (::rename (_path.c_str(), newpath.c_str()) != 0) {
559 PBD::error << string_compose (_("cannot rename midi file source from %1 to %2 (%3)"),
560 _path, newpath, strerror (errno))
565 if (::unlink (peakpath.c_str()) != 0) {
566 PBD::error << string_compose (_("cannot remove peakfile %1 for %2 (%3)"),
567 peakpath, _path, strerror (errno))
569 /* try to back out */
570 rename (newpath.c_str(), _path.c_str());
577 /* file can not be removed twice, since the operation is not idempotent */
579 _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
584 // FIXME: Merge this with audiofilesource somehow (make a generic filesource?)
586 SMFSource::find (string pathstr, bool must_exist, bool& isnew)
588 string::size_type pos;
593 /* clean up PATH:CHANNEL notation so that we are looking for the correct path */
595 if ((pos = pathstr.find_last_of (':')) == string::npos) {
598 pathstr = pathstr.substr (0, pos);
601 if (pathstr[0] != '/') {
603 /* non-absolute pathname: find pathstr in search path */
610 if (_search_path.length() == 0) {
611 PBD::error << _("FileSource: search path not set") << endmsg;
615 split (_search_path, dirs, ':');
619 for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
622 if (fullpath[fullpath.length()-1] != '/') {
627 if (access (fullpath.c_str(), R_OK) == 0) {
635 PBD::error << string_compose (_("FileSource: \"%1\" is ambigous when searching %2\n\t"), pathstr, _search_path) << endmsg;
638 } else if (cnt == 0) {
641 PBD::error << string_compose(_("Filesource: cannot find required file (%1): while searching %2"), pathstr, _search_path) << endmsg;
654 /* external files and/or very very old style sessions include full paths */
657 _name = pathstr.substr (pathstr.find_last_of ('/') + 1);
659 if (access (_path.c_str(), R_OK) != 0) {
661 /* file does not exist or we cannot read it */
664 PBD::error << string_compose(_("Filesource: cannot find required file (%1): %2"), _path, strerror (errno)) << endmsg;
668 if (errno != ENOENT) {
669 PBD::error << string_compose(_("Filesource: cannot check for existing file (%1): %2"), _path, strerror (errno)) << endmsg;
691 SMFSource::set_search_path (string p)
698 SMFSource::set_allow_remove_if_empty (bool yn)
701 _allow_remove_if_empty = yn;
706 SMFSource::set_source_name (string newname, bool destructive)
708 //Glib::Mutex::Lock lm (_lock); FIXME
709 string oldpath = _path;
710 string newpath = Session::change_midi_path_by_name (oldpath, _name, newname, destructive);
712 if (newpath.empty()) {
713 PBD::error << string_compose (_("programming error: %1"), "cannot generate a changed midi path") << endmsg;
717 if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
718 PBD::error << string_compose (_("cannot rename midi file for %1 to %2"), _name, newpath) << endmsg;
722 _name = Glib::path_get_basename (newpath);
725 return 0;//rename_peakfile (peak_path (_path));
729 SMFSource::is_empty () const
731 bool ret = (_track_size > 4);
733 cerr << name() << " IS EMPTY: " << ret << endl;
740 SMFSource::write_chunk_header(char id[4], uint32_t length)
742 const uint32_t length_be = GUINT32_TO_BE(length);
744 fwrite(id, 1, 4, _fd);
745 fwrite(&length_be, 4, 1, _fd);
749 SMFSource::write_chunk(char id[4], uint32_t length, void* data)
751 write_chunk_header(id, length);
753 fwrite(data, 1, length, _fd);
756 /** Returns the size (in bytes) of the value written. */
758 SMFSource::write_var_len(uint32_t value)
762 uint32_t buffer = value & 0x7F;
764 while ( (value >>= 7) ) {
766 buffer |= ((value & 0x7F) | 0x80);
770 //printf("Writing var len byte %X\n", (unsigned char)buffer);
783 SMFSource::read_var_len() const
787 //int offset = ftell(_fd);
788 //cerr << "SMF - reading var len at " << offset << endl;
793 if ( (value = getc(_fd)) & 0x80 ) {
797 value = (value << 7) + ((c = getc(_fd)) & 0x7F);
805 SMFSource::load_model(bool lock, bool force_reload)
811 Glib::Mutex::Lock lm (_lock);
813 if (_model && _model_loaded && ! force_reload) {
819 cerr << "SMFSource: Loading new model " << _model.get() << endl;
820 _model = boost::shared_ptr<MidiModel>(new MidiModel(_session));
822 cerr << "SMFSource: Reloading model " << _model.get() << endl;
826 _model->start_write();
828 fseek(_fd, _header_size, 0);
830 uint64_t time = 0; /* in SMF ticks */
831 jack_midi_event_t ev;
836 size_t scratch_size = 0; // keep track of scratch and minimize reallocs
838 // FIXME: assumes tempo never changes after start
839 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
840 _session.engine().frame_rate());
843 while ((ret = read_event(ev)) >= 0) {
847 const double ev_time = (double)(time * frames_per_beat / (double)_ppqn); // in frames
849 if (ret > 0) { // didn't skip (meta) event
850 _model->append(ev_time, ev.size, ev.buffer);
853 if (ev.size > scratch_size)
854 scratch_size = ev.size;
856 ev.size = scratch_size;
859 _model->end_write(false); /* FIXME: delete stuck notes iff percussion? */
863 _model_loaded = true;
868 SMFSource::destroy_model()
870 cerr << "SMFSource: Destroying model " << _model.get() << endl;