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
167 return (_fd == 0) ? -1 : 0;
171 SMFSource::seek_to_end()
173 fseek(_fd, -4, SEEK_END);
177 SMFSource::flush_header ()
179 // FIXME: write timeline position somehow?
181 //cerr << "SMF Flushing header\n";
185 const uint16_t type = GUINT16_TO_BE(0); // SMF Type 0 (single track)
186 const uint16_t ntracks = GUINT16_TO_BE(1); // Number of tracks (always 1 for Type 0)
187 const uint16_t division = GUINT16_TO_BE(_ppqn); // Pulses per quarter note (beat)
190 memcpy(data, &type, 2);
191 memcpy(data+2, &ntracks, 2);
192 memcpy(data+4, &division, 2);
194 _fd = freopen(path().c_str(), "r+", _fd);
197 write_chunk("MThd", 6, data);
198 write_chunk_header("MTrk", _track_size);
206 SMFSource::flush_footer()
216 SMFSource::write_footer()
218 //cerr << "SMF " << name() << " writing EOT at byte " << ftell(_fd) << endl;
221 char eot[3] = { 0xFF, 0x2F, 0x00 }; // end-of-track meta-event
222 fwrite(eot, 1, 3, _fd);
226 /** Returns the offset of the first event in the file with a time past @a start,
227 * relative to the start of the source.
229 * Returns -1 if not found.
233 SMFSource::find_first_event_after(nframes_t start)
235 // FIXME: obviously this is slooow
237 fseek(_fd, _header_size, 0);
239 while ( ! feof(_fd) ) {
240 const uint32_t delta_time = read_var_len();
242 if (delta_time > start)
250 /** Read an event from the current position in file.
252 * File position MUST be at the beginning of a delta time, or this will die very messily.
253 * ev.buffer must be of size ev.size, and large enough for the event. The returned event
254 * will have it's time field set to it's delta time, in SMF tempo-based ticks, using the
255 * rate given by ppqn() (it is the caller's responsibility to calculate a real time).
257 * \a size should be the capacity of \a buf. If it is not large enough, \a buf will
258 * be freed and a new buffer allocated in its place, the size of which will be placed
261 * Returns event length (including status byte) on success, 0 if event was
262 * skipped (eg a meta event), or -1 on EOF (or end of track).
265 SMFSource::read_event(uint32_t* delta_t, uint32_t* size, Byte** buf) const
275 *delta_t = read_var_len();
278 const int status = fgetc(_fd);
279 assert(status != EOF); // FIXME die gracefully
281 //printf("Status @ %X = %X\n", (unsigned)ftell(_fd) - 1, status);
283 if (status == 0xFF) {
285 const int type = fgetc(_fd);
286 if ((unsigned char)type == 0x2F) {
287 //cerr << _name << " hit EOT" << endl;
295 const int event_size = midi_event_size((unsigned char)status) + 1;
296 if (event_size <= 0) {
301 // Make sure we have enough scratch buffer
302 if (*size < (unsigned)event_size)
303 *buf = (Byte*)realloc(*buf, event_size);
307 /*if (ev.buffer == NULL)
308 ev.buffer = (Byte*)malloc(sizeof(Byte) * ev.size);*/
310 (*buf)[0] = (unsigned char)status;
312 fread((*buf) + 1, 1, *size - 1, _fd);
314 /*printf("%s read event: delta = %u, size = %u, data = ", _name.c_str(), *delta_t, *size);
315 for (size_t i=0; i < *size; ++i) {
316 printf("%X ", (*buf)[i]);
323 /** All stamps in audio frames */
325 SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset) const
327 //cerr << "SMF " << name() << " read " << start << ", count=" << cnt << ", offset=" << stamp_offset << endl;
329 // 64 bits ought to be enough for anybody
330 uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
332 _read_data_count = 0;
334 // Output parameters for read_event (which will allocate scratch in buffer as needed)
335 uint32_t ev_delta_t = 0;
336 uint32_t ev_size = 0;
339 size_t scratch_size = 0; // keep track of scratch to minimize reallocs
341 // FIXME: don't seek to start and search every read (brutal!)
342 fseek(_fd, _header_size, 0);
344 // FIXME: assumes tempo never changes after start
345 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
346 _session.engine().frame_rate(),
347 _session.tempo_map().meter_at(_timeline_position));
349 const uint64_t start_ticks = (uint64_t)((start / frames_per_beat) * _ppqn);
352 int ret = read_event(&ev_delta_t, &ev_size, &ev_buffer);
353 if (ret == -1) { // EOF
354 //cerr << "SMF - EOF\n";
358 if (ret == 0) { // meta-event (skipped)
359 //cerr << "SMF - META\n";
360 time += ev_delta_t; // just accumulate delta time and ignore event
364 time += ev_delta_t; // accumulate delta time
366 if (time >= start_ticks) {
367 const nframes_t ev_frame_time = (nframes_t)(
368 ((time / (double)_ppqn) * frames_per_beat)) + stamp_offset;
370 if (ev_frame_time <= start + cnt)
371 dst.write(ev_frame_time, ev_size, ev_buffer);
376 _read_data_count += ev_size;
378 if (ev_size > scratch_size)
379 scratch_size = ev_size;
381 ev_size = scratch_size; // minimize realloc in read_event
387 /** All stamps in audio frames */
389 SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
391 _write_data_count = 0;
396 size_t buf_capacity = 4;
397 Byte* buf = (Byte*)malloc(buf_capacity);
399 if (_model && ! _model->writing())
400 _model->start_write();
403 bool ret = src.full_peek(sizeof(double), (Byte*)&time);
404 if (!ret || time - _timeline_position > _length + cnt)
407 ret = src.read_prefix(&time, &size);
411 if (size > buf_capacity) {
413 buf = (Byte*)realloc(buf, size);
416 ret = src.read_contents(size, buf);
418 cerr << "ERROR: Read time/size but not buffer, corrupt MIDI ring buffer" << endl;
422 assert(time >= _timeline_position);
423 time -= _timeline_position;
425 const MidiEvent ev(time, size, buf);
426 append_event_unlocked(ev);
435 const nframes_t oldlen = _length;
436 update_length(oldlen, cnt);
438 ViewDataRangeReady (_timeline_position + oldlen, cnt); /* EMIT SIGNAL */
445 SMFSource::append_event_unlocked(const MidiEvent& ev)
447 /*printf("SMF %s - writing event, time = %lf, size = %u, data = ", _path.c_str(), ev.time(), ev.size());
448 for (size_t i=0; i < ev.size(); ++i) {
449 printf("%X ", ev.buffer()[i]);
453 assert(ev.time() >= 0);
455 assert(ev.time() >= _last_ev_time);
457 // FIXME: assumes tempo never changes after start
458 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
459 _session.engine().frame_rate(),
460 _session.tempo_map().meter_at(_timeline_position));
462 const uint32_t delta_time = (uint32_t)((ev.time() - _last_ev_time) / frames_per_beat * _ppqn);
464 const size_t stamp_size = write_var_len(delta_time);
465 fwrite(ev.buffer(), 1, ev.size(), _fd);
467 _track_size += stamp_size + ev.size();
468 _write_data_count += ev.size();
470 _last_ev_time = ev.time();
475 SMFSource::get_state ()
477 XMLNode& root (MidiSource::get_state());
479 snprintf (buf, sizeof (buf), "0x%x", (int)_flags);
480 root.add_property ("flags", buf);
485 SMFSource::set_state (const XMLNode& node)
487 const XMLProperty* prop;
489 if (MidiSource::set_state (node)) {
493 if ((prop = node.property (X_("flags"))) != 0) {
496 sscanf (prop->value().c_str(), "0x%x", &ival);
497 _flags = Flag (ival);
505 assert(_name.find("/") == string::npos);
511 SMFSource::mark_for_remove ()
516 _flags = Flag (_flags | RemoveAtDestroy);
520 SMFSource::mark_streaming_midi_write_started (NoteMode mode, nframes_t start_frame)
522 MidiSource::mark_streaming_midi_write_started (mode, start_frame);
527 SMFSource::mark_streaming_write_completed ()
529 MidiSource::mark_streaming_write_completed();
539 Glib::Mutex::Lock lm (_lock);
542 next_peak_clear_should_notify = true;
544 if (_peaks_built || pending_peak_builds.empty()) {
546 PeaksReady (); /* EMIT SIGNAL */
552 SMFSource::mark_take (string id)
560 SMFSource::move_to_trash (const string trash_dir_name)
568 /* don't move the file across filesystems, just
569 stick it in the 'trash_dir_name' directory
570 on whichever filesystem it was already on.
573 newpath = Glib::path_get_dirname (_path);
574 newpath = Glib::path_get_dirname (newpath);
577 newpath += trash_dir_name;
579 newpath += Glib::path_get_basename (_path);
581 if (access (newpath.c_str(), F_OK) == 0) {
583 /* the new path already exists, try versioning */
585 char buf[PATH_MAX+1];
589 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
592 while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
593 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
597 if (version == 999) {
598 PBD::error << string_compose (_("there are already 1000 files with names like %1; versioning discontinued"),
607 /* it doesn't exist, or we can't read it or something */
611 if (::rename (_path.c_str(), newpath.c_str()) != 0) {
612 PBD::error << string_compose (_("cannot rename midi file source from %1 to %2 (%3)"),
613 _path, newpath, strerror (errno))
618 if (::unlink (peakpath.c_str()) != 0) {
619 PBD::error << string_compose (_("cannot remove peakfile %1 for %2 (%3)"),
620 peakpath, _path, strerror (errno))
622 /* try to back out */
623 rename (newpath.c_str(), _path.c_str());
630 /* file can not be removed twice, since the operation is not idempotent */
632 _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
638 SMFSource::safe_file_extension(const Glib::ustring& file)
640 return (file.rfind(".mid") != Glib::ustring::npos);
643 // FIXME: Merge this with audiofilesource somehow (make a generic filesource?)
645 SMFSource::find (string pathstr, bool must_exist, bool& isnew)
647 string::size_type pos;
652 /* clean up PATH:CHANNEL notation so that we are looking for the correct path */
654 if ((pos = pathstr.find_last_of (':')) == string::npos) {
657 pathstr = pathstr.substr (0, pos);
660 if (pathstr[0] != '/') {
662 /* non-absolute pathname: find pathstr in search path */
669 if (_search_path.length() == 0) {
670 PBD::error << _("FileSource: search path not set") << endmsg;
674 split (_search_path, dirs, ':');
678 for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
681 if (fullpath[fullpath.length()-1] != '/') {
686 if (access (fullpath.c_str(), R_OK) == 0) {
694 PBD::error << string_compose (_("FileSource: \"%1\" is ambigous when searching %2\n\t"), pathstr, _search_path) << endmsg;
697 } else if (cnt == 0) {
700 PBD::error << string_compose(_("Filesource: cannot find required file (%1): while searching %2"), pathstr, _search_path) << endmsg;
713 /* external files and/or very very old style sessions include full paths */
716 _name = pathstr.substr (pathstr.find_last_of ('/') + 1);
718 if (access (_path.c_str(), R_OK) != 0) {
720 /* file does not exist or we cannot read it */
723 PBD::error << string_compose(_("Filesource: cannot find required file (%1): %2"), _path, strerror (errno)) << endmsg;
727 if (errno != ENOENT) {
728 PBD::error << string_compose(_("Filesource: cannot check for existing file (%1): %2"), _path, strerror (errno)) << endmsg;
750 SMFSource::set_search_path (string p)
757 SMFSource::set_allow_remove_if_empty (bool yn)
760 _allow_remove_if_empty = yn;
765 SMFSource::set_source_name (string newname, bool destructive)
767 //Glib::Mutex::Lock lm (_lock); FIXME
768 string oldpath = _path;
769 string newpath = Session::change_midi_path_by_name (oldpath, _name, newname, destructive);
771 if (newpath.empty()) {
772 PBD::error << string_compose (_("programming error: %1"), "cannot generate a changed midi path") << endmsg;
776 if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
777 PBD::error << string_compose (_("cannot rename midi file for %1 to %2"), _name, newpath) << endmsg;
781 _name = Glib::path_get_basename (newpath);
784 return 0;//rename_peakfile (peak_path (_path));
788 SMFSource::is_empty () const
790 bool ret = (_track_size > 4);
792 //cerr << name() << " IS EMPTY: " << ret << endl;
799 SMFSource::write_chunk_header(const char id[4], uint32_t length)
801 const uint32_t length_be = GUINT32_TO_BE(length);
803 fwrite(id, 1, 4, _fd);
804 fwrite(&length_be, 4, 1, _fd);
808 SMFSource::write_chunk(const char id[4], uint32_t length, void* data)
810 write_chunk_header(id, length);
812 fwrite(data, 1, length, _fd);
815 /** Returns the size (in bytes) of the value written. */
817 SMFSource::write_var_len(uint32_t value)
821 uint32_t buffer = value & 0x7F;
823 while ( (value >>= 7) ) {
825 buffer |= ((value & 0x7F) | 0x80);
829 //printf("Writing var len byte %X\n", (unsigned char)buffer);
842 SMFSource::read_var_len() const
849 if ( (value = getc(_fd)) & 0x80 ) {
853 value = (value << 7) + ((c = getc(_fd)) & 0x7F);
861 SMFSource::load_model(bool lock, bool force_reload)
867 Glib::Mutex::Lock lm (_lock);
869 if (_model && !force_reload && !_model->empty()) {
870 //cerr << _name << " NOT reloading model " << _model.get() << " (" << _model->n_notes()
871 // << " notes)" << endl;
874 cerr << _name << " loading model" << endl;
878 _model = boost::shared_ptr<MidiModel>(new MidiModel(_session));
879 cerr << _name << " loaded new model " << _model.get() << endl;
881 cerr << _name << " reloading model " << _model.get()
882 << " (" << _model->n_notes() << " notes)" <<endl;
886 _model->start_write();
888 fseek(_fd, _header_size, 0);
890 uint64_t time = 0; /* in SMF ticks */
893 size_t scratch_size = 0; // keep track of scratch and minimize reallocs
895 // FIXME: assumes tempo never changes after start
896 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
897 _session.engine().frame_rate(),
898 _session.tempo_map().meter_at(_timeline_position));
900 uint32_t delta_t = 0;
902 while ((ret = read_event(&delta_t, &ev.size(), &ev.buffer())) >= 0) {
906 if (ret > 0) { // didn't skip (meta) event
907 // make ev.time absolute time in frames
908 ev.time() = (double)time * frames_per_beat / (double)_ppqn;
913 if (ev.size() > scratch_size)
914 scratch_size = ev.size();
916 ev.size() = scratch_size;
919 _model->end_write(false);
926 SMFSource::destroy_model()
928 //cerr << _name << " destroying model " << _model.get() << endl;