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>
41 #include <ardour/smf_reader.h>
45 using namespace ARDOUR;
47 string SMFSource::_search_path;
49 /*sigc::signal<void,struct tm*, time_t> SMFSource::HeaderPositionOffsetChanged;
50 bool SMFSource::header_position_negative;
51 uint64_t SMFSource::header_position_offset;
54 SMFSource::SMFSource (Session& s, std::string path, Flag flags)
55 : 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
64 /* constructor used for new internal-to-session files. file cannot exist */
66 if (init (path, false)) {
67 throw failed_constructor ();
71 throw failed_constructor ();
74 cerr << "SMF Source path: " << path << endl;
76 assert(_name.find("/") == string::npos);
79 SMFSource::SMFSource (Session& s, const XMLNode& node)
80 : 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
89 /* constructor used for existing internal-to-session files. file must exist */
91 if (set_state (node)) {
92 throw failed_constructor ();
95 if (init (_name, true)) {
96 throw failed_constructor ();
100 throw failed_constructor ();
103 assert(_name.find("/") == string::npos);
106 SMFSource::~SMFSource ()
109 unlink (_path.c_str());
114 SMFSource::removable () const
116 return (_flags & Removable) && ((_flags & RemoveAtDestroy) ||
117 ((_flags & RemovableIfEmpty) && is_empty()));
121 SMFSource::init (string pathstr, bool must_exist)
125 if (!find (pathstr, must_exist, is_new)) {
126 cerr << "cannot find " << pathstr << " with me = " << must_exist << endl;
130 if (is_new && must_exist) {
134 assert(_name.find("/") == string::npos);
138 /** Attempt to open the SMF file for reading and writing.
140 * Currently SMFSource is always read/write.
142 * \return 0 on success
143 * -1 if the file can not be opened for reading,
144 * -2 if the file can not be opened for writing
149 //cerr << "Opening SMF file " << path() << " writeable: " << writable() << endl;
151 assert(writable()); // FIXME;
153 _fd = fopen(path().c_str(), "r+");
155 // File already exists
157 fseek(_fd, _header_size - 4, 0);
158 uint32_t track_size_be = 0;
159 fread(&track_size_be, 4, 1, _fd);
160 _track_size = GUINT32_FROM_BE(track_size_be);
161 _empty = _track_size > 4;
162 //cerr << "SMF - read track size " << _track_size << endl;
164 // We're making a new file
166 _fd = fopen(path().c_str(), "w+");
168 cerr << "ERROR: Can not open SMF file " << path() << " for writing: " <<
169 strerror(errno) << endl;
175 // Write a tentative header just to pad things out so writing happens in the right spot
180 return (_fd == 0) ? -1 : 0;
195 SMFSource::seek_to_footer_position()
199 // lets check if there is a track end marker at the end of the data
200 fseek(_fd, -4, SEEK_END);
201 //cerr << "SMFSource::seek_to_footer_position: At position: " << ftell(_fd);
202 size_t read_bytes = fread(buffer, sizeof(uint8_t), 4, _fd);
203 /*cerr << " read size: " << read_bytes << " buffer: ";
204 for (size_t i=0; i < read_bytes; ++i) {
205 printf("%x ", buffer[i]);
210 if( (read_bytes == 4) &&
215 // there is one, so overwrite it
216 fseek(_fd, -4, SEEK_END);
218 // there is none, so append
219 fseek(_fd, 0, SEEK_END);
224 SMFSource::flush_header()
226 // FIXME: write timeline position somehow?
228 //cerr << path() << " SMF Flushing header\n";
232 const uint16_t type = GUINT16_TO_BE(0); // SMF Type 0 (single track)
233 const uint16_t ntracks = GUINT16_TO_BE(1); // Number of tracks (always 1 for Type 0)
234 const uint16_t division = GUINT16_TO_BE(_ppqn); // Pulses per quarter note (beat)
237 memcpy(data, &type, 2);
238 memcpy(data+2, &ntracks, 2);
239 memcpy(data+4, &division, 2);
241 _fd = freopen(path().c_str(), "r+", _fd);
243 fseek(_fd, 0, SEEK_SET);
244 write_chunk("MThd", 6, data);
245 write_chunk_header("MTrk", _track_size);
253 SMFSource::flush_footer()
255 //cerr << path() << " SMF Flushing footer\n";
256 seek_to_footer_position();
258 seek_to_footer_position();
264 SMFSource::write_footer()
267 char eot[3] = { 0xFF, 0x2F, 0x00 }; // end-of-track meta-event
268 fwrite(eot, 1, 3, _fd);
272 /** Returns the offset of the first event in the file with a time past @a start,
273 * relative to the start of the source.
275 * Returns -1 if not found.
279 SMFSource::find_first_event_after(nframes_t start)
281 // FIXME: obviously this is slooow
283 fseek(_fd, _header_size, 0);
285 while ( ! feof(_fd) ) {
286 const uint32_t delta_time = read_var_len();
288 if (delta_time > start)
296 /** Read an event from the current position in file.
298 * File position MUST be at the beginning of a delta time, or this will die very messily.
299 * ev.buffer must be of size ev.size, and large enough for the event. The returned event
300 * will have it's time field set to it's delta time, in SMF tempo-based ticks, using the
301 * rate given by ppqn() (it is the caller's responsibility to calculate a real time).
303 * \a size should be the capacity of \a buf. If it is not large enough, \a buf will
304 * be freed and a new buffer allocated in its place, the size of which will be placed
307 * Returns event length (including status byte) on success, 0 if event was
308 * skipped (eg a meta event), or -1 on EOF (or end of track).
311 SMFSource::read_event(uint32_t* delta_t, uint32_t* size, Byte** buf) const
322 *delta_t = SMFReader::read_var_len(_fd);
324 return -1; // Premature EOF
328 return -1; // Premature EOF
331 const int status = fgetc(_fd);
334 return -1; // Premature EOF
337 //printf("Status @ %X = %X\n", (unsigned)ftell(_fd) - 1, status);
339 if (status == 0xFF) {
341 return -1; // Premature EOF
343 const int type = fgetc(_fd);
344 if ((unsigned char)type == 0x2F) {
345 return -1; // hit end of track
352 const int event_size = midi_event_size((unsigned char)status) + 1;
353 if (event_size <= 0) {
358 // Make sure we have enough scratch buffer
359 if (*size < (unsigned)event_size)
360 *buf = (Byte*)realloc(*buf, event_size);
364 (*buf)[0] = (unsigned char)status;
366 fread((*buf) + 1, 1, *size - 1, _fd);
368 /*printf("SMFSource %s read event: delta = %u, size = %u, data = ", _name.c_str(), *delta_t, *size);
369 for (size_t i=0; i < *size; ++i) {
370 printf("%X ", (*buf)[i]);
377 /** All stamps in audio frames */
379 SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset, nframes_t negative_stamp_offset) const
381 //cerr << "SMF read_unlocked " << name() << " read " << start << ", count=" << cnt << ", offset=" << stamp_offset << endl;
383 // 64 bits ought to be enough for anybody
384 uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
386 _read_data_count = 0;
388 // Output parameters for read_event (which will allocate scratch in buffer as needed)
389 uint32_t ev_delta_t = 0;
390 uint32_t ev_size = 0;
393 size_t scratch_size = 0; // keep track of scratch to minimize reallocs
395 // FIXME: don't seek to start and search every read (brutal!)
396 fseek(_fd, _header_size, SEEK_SET);
398 // FIXME: assumes tempo never changes after start
399 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
400 _session.engine().frame_rate(),
401 _session.tempo_map().meter_at(_timeline_position));
403 const uint64_t start_ticks = (uint64_t)((start / frames_per_beat) * _ppqn);
406 int ret = read_event(&ev_delta_t, &ev_size, &ev_buffer);
407 if (ret == -1) { // EOF
408 //cerr << "SMF - EOF\n";
412 if (ret == 0) { // meta-event (skipped)
413 //cerr << "SMF - META\n";
414 time += ev_delta_t; // just accumulate delta time and ignore event
418 time += ev_delta_t; // accumulate delta time
420 if (time >= start_ticks) {
421 const nframes_t ev_frame_time = (nframes_t)(
422 ((time / (double)_ppqn) * frames_per_beat)) + stamp_offset;
424 if (ev_frame_time <= start + cnt)
425 dst.write(ev_frame_time - negative_stamp_offset, ev_size, ev_buffer);
430 _read_data_count += ev_size;
432 if (ev_size > scratch_size)
433 scratch_size = ev_size;
435 ev_size = scratch_size; // minimize realloc in read_event
441 /** All stamps in audio frames */
443 SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
445 _write_data_count = 0;
450 size_t buf_capacity = 4;
451 Byte* buf = (Byte*)malloc(buf_capacity);
453 if (_model && ! _model->writing())
454 _model->start_write();
457 bool ret = src.full_peek(sizeof(double), (Byte*)&time);
458 if (!ret || time - _timeline_position > _length + cnt)
461 ret = src.read_prefix(&time, &size);
465 if (size > buf_capacity) {
467 buf = (Byte*)realloc(buf, size);
470 ret = src.read_contents(size, buf);
472 cerr << "ERROR: Read time/size but not buffer, corrupt MIDI ring buffer" << endl;
476 assert(time >= _timeline_position);
477 time -= _timeline_position;
479 const MIDI::Event ev(time, size, buf);
480 if (! (ev.is_channel_event() || ev.is_smf_meta_event() || ev.is_sysex()) ) {
481 //cerr << "SMFSource: WARNING: caller tried to write non SMF-Event of type " << std::hex << int(ev.buffer()[0]) << endl;
485 append_event_unlocked(Frames, ev);
494 const nframes_t oldlen = _length;
495 update_length(oldlen, cnt);
497 ViewDataRangeReady (_timeline_position + oldlen, cnt); /* EMIT SIGNAL */
504 SMFSource::append_event_unlocked(EventTimeUnit unit, const MIDI::Event& ev)
506 /*printf("SMFSource: %s - append_event_unlocked chan = %u, time = %lf, size = %u, data = ",
507 name().c_str(), (unsigned)ev.channel(), ev.time(), ev.size());
508 for (size_t i=0; i < ev.size(); ++i) {
509 printf("%X ", ev.buffer()[i]);
513 assert(ev.time() >= 0);
515 if (ev.time() < _last_ev_time) {
516 cerr << "SMFSource: Warning: Skipping event with ev.time() < _last_ev_time" << endl;
520 uint32_t delta_time = 0;
522 if (unit == Frames) {
523 // FIXME: assumes tempo never changes after start
524 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
525 _session.engine().frame_rate(),
526 _session.tempo_map().meter_at(_timeline_position));
528 delta_time = (uint32_t)((ev.time() - _last_ev_time) / frames_per_beat * _ppqn);
530 assert(unit == Beats);
531 delta_time = (uint32_t)((ev.time() - _last_ev_time) * _ppqn);
535 const size_t stamp_size = write_var_len(delta_time);
536 fwrite(ev.buffer(), 1, ev.size(), _fd);
538 _track_size += stamp_size + ev.size();
539 _write_data_count += ev.size();
540 _last_ev_time = ev.time();
548 SMFSource::get_state ()
550 XMLNode& root (MidiSource::get_state());
552 snprintf (buf, sizeof (buf), "0x%x", (int)_flags);
553 root.add_property ("flags", buf);
558 SMFSource::set_state (const XMLNode& node)
560 const XMLProperty* prop;
562 if (MidiSource::set_state (node)) {
566 if ((prop = node.property (X_("flags"))) != 0) {
569 sscanf (prop->value().c_str(), "0x%x", &ival);
570 _flags = Flag (ival);
578 assert(_name.find("/") == string::npos);
584 SMFSource::mark_for_remove ()
589 _flags = Flag (_flags | RemoveAtDestroy);
593 SMFSource::mark_streaming_midi_write_started (NoteMode mode, nframes_t start_frame)
595 MidiSource::mark_streaming_midi_write_started (mode, start_frame);
597 fseek(_fd, _header_size, SEEK_SET);
601 SMFSource::mark_streaming_write_completed ()
603 MidiSource::mark_streaming_write_completed();
609 _model->set_edited(false);
615 SMFSource::mark_take (string id)
623 SMFSource::move_to_trash (const string trash_dir_name)
631 /* don't move the file across filesystems, just
632 stick it in the 'trash_dir_name' directory
633 on whichever filesystem it was already on.
636 newpath = Glib::path_get_dirname (_path);
637 newpath = Glib::path_get_dirname (newpath);
640 newpath += trash_dir_name;
642 newpath += Glib::path_get_basename (_path);
644 if (access (newpath.c_str(), F_OK) == 0) {
646 /* the new path already exists, try versioning */
648 char buf[PATH_MAX+1];
652 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
655 while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
656 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
660 if (version == 999) {
661 PBD::error << string_compose (_("there are already 1000 files with names like %1; versioning discontinued"),
670 /* it doesn't exist, or we can't read it or something */
674 if (::rename (_path.c_str(), newpath.c_str()) != 0) {
675 PBD::error << string_compose (_("cannot rename midi file source from %1 to %2 (%3)"),
676 _path, newpath, strerror (errno))
681 if (::unlink (peakpath.c_str()) != 0) {
682 PBD::error << string_compose (_("cannot remove peakfile %1 for %2 (%3)"),
683 peakpath, _path, strerror (errno))
685 /* try to back out */
686 rename (newpath.c_str(), _path.c_str());
693 /* file can not be removed twice, since the operation is not idempotent */
695 _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
701 SMFSource::safe_file_extension(const Glib::ustring& file)
703 return (file.rfind(".mid") != Glib::ustring::npos);
706 // FIXME: Merge this with audiofilesource somehow (make a generic filesource?)
708 SMFSource::find (string pathstr, bool must_exist, bool& isnew)
710 string::size_type pos;
715 /* clean up PATH:CHANNEL notation so that we are looking for the correct path */
717 if ((pos = pathstr.find_last_of (':')) == string::npos) {
720 pathstr = pathstr.substr (0, pos);
723 if (pathstr[0] != '/') {
725 /* non-absolute pathname: find pathstr in search path */
732 if (_search_path.length() == 0) {
733 PBD::error << _("FileSource: search path not set") << endmsg;
737 split (_search_path, dirs, ':');
741 for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
744 if (fullpath[fullpath.length()-1] != '/') {
749 if (access (fullpath.c_str(), R_OK) == 0) {
757 PBD::error << string_compose (_("FileSource: \"%1\" is ambigous when searching %2\n\t"), pathstr, _search_path) << endmsg;
760 } else if (cnt == 0) {
763 PBD::error << string_compose(_("Filesource: cannot find required file (%1): while searching %2"), pathstr, _search_path) << endmsg;
776 /* external files and/or very very old style sessions include full paths */
779 _name = pathstr.substr (pathstr.find_last_of ('/') + 1);
781 if (access (_path.c_str(), R_OK) != 0) {
783 /* file does not exist or we cannot read it */
786 PBD::error << string_compose(_("Filesource: cannot find required file (%1): %2"), _path, strerror (errno)) << endmsg;
790 if (errno != ENOENT) {
791 PBD::error << string_compose(_("Filesource: cannot check for existing file (%1): %2"), _path, strerror (errno)) << endmsg;
813 SMFSource::set_search_path (string p)
820 SMFSource::set_allow_remove_if_empty (bool yn)
823 _allow_remove_if_empty = yn;
828 SMFSource::set_source_name (string newname, bool destructive)
830 //Glib::Mutex::Lock lm (_lock); FIXME
831 string oldpath = _path;
832 string newpath = Session::change_midi_path_by_name (oldpath, _name, newname, destructive);
834 if (newpath.empty()) {
835 PBD::error << string_compose (_("programming error: %1"), "cannot generate a changed midi path") << endmsg;
839 if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
840 PBD::error << string_compose (_("cannot rename midi file for %1 to %2"), _name, newpath) << endmsg;
844 _name = Glib::path_get_basename (newpath);
847 return 0;//rename_peakfile (peak_path (_path));
851 SMFSource::is_empty () const
858 SMFSource::write_chunk_header(const char id[4], uint32_t length)
860 const uint32_t length_be = GUINT32_TO_BE(length);
862 fwrite(id, 1, 4, _fd);
863 fwrite(&length_be, 4, 1, _fd);
867 SMFSource::write_chunk(const char id[4], uint32_t length, void* data)
869 write_chunk_header(id, length);
871 fwrite(data, 1, length, _fd);
874 /** Returns the size (in bytes) of the value written. */
876 SMFSource::write_var_len(uint32_t value)
880 uint32_t buffer = value & 0x7F;
882 while ( (value >>= 7) ) {
884 buffer |= ((value & 0x7F) | 0x80);
888 //printf("Writing var len byte %X\n", (unsigned char)buffer);
901 SMFSource::load_model(bool lock, bool force_reload)
907 Glib::Mutex::Lock lm (_lock);
909 if (_model && !force_reload && !_model->empty())
913 _model = boost::shared_ptr<MidiModel>(new MidiModel(this));
914 cerr << _name << " loaded new model " << _model.get() << endl;
916 cerr << _name << " reloading model " << _model.get()
917 << " (" << _model->n_notes() << " notes)" <<endl;
921 _model->start_write();
923 fseek(_fd, _header_size, SEEK_SET);
925 uint64_t time = 0; /* in SMF ticks */
928 size_t scratch_size = 0; // keep track of scratch and minimize reallocs
930 // FIXME: assumes tempo never changes after start
931 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
932 _session.engine().frame_rate(),
933 _session.tempo_map().meter_at(_timeline_position));
935 uint32_t delta_t = 0;
937 while ((ret = read_event(&delta_t, &ev.size(), &ev.buffer())) >= 0) {
941 if (ret > 0) { // didn't skip (meta) event
942 // make ev.time absolute time in frames
943 ev.time() = (double)time * frames_per_beat / (double)_ppqn;
948 if (ev.size() > scratch_size)
949 scratch_size = ev.size();
951 ev.size() = scratch_size;
954 _model->end_write(false);
955 _model->set_edited(false);
962 SMFSource::destroy_model()
964 //cerr << _name << " destroying model " << _model.get() << endl;