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))
57 , _flags (Flag(flags | Writable)) // FIXME: this needs to be writable for now
58 , _allow_remove_if_empty(true)
61 , _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)
82 , _flags (Flag (Writable|CanRename))
83 , _allow_remove_if_empty(true)
86 , _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);
141 //cerr << "Opening SMF file " << path() << " writeable: " << writable() << endl;
143 assert(writable()); // FIXME;
145 _fd = fopen(path().c_str(), "r+");
147 // File already exists
149 fseek(_fd, _header_size - 4, 0);
150 uint32_t track_size_be = 0;
151 fread(&track_size_be, 4, 1, _fd);
152 _track_size = GUINT32_FROM_BE(track_size_be);
153 //cerr << "SMF - read track size " << _track_size << endl;
155 // We're making a new file
157 _fd = fopen(path().c_str(), "w+");
160 // Write a tentative header just to pad things out so writing happens in the right spot
166 return (_fd == 0) ? -1 : 0;
170 SMFSource::seek_to_end()
172 fseek(_fd, -4, SEEK_END);
176 SMFSource::flush_header ()
178 // FIXME: write timeline position somehow?
180 //cerr << "SMF Flushing header\n";
184 const uint16_t type = GUINT16_TO_BE(0); // SMF Type 0 (single track)
185 const uint16_t ntracks = GUINT16_TO_BE(1); // Number of tracks (always 1 for Type 0)
186 const uint16_t division = GUINT16_TO_BE(_ppqn); // Pulses per quarter note (beat)
189 memcpy(data, &type, 2);
190 memcpy(data+2, &ntracks, 2);
191 memcpy(data+4, &division, 2);
193 _fd = freopen(path().c_str(), "r+", _fd);
195 fseek(_fd, 0, SEEK_SET);
196 write_chunk("MThd", 6, data);
197 write_chunk_header("MTrk", _track_size);
205 SMFSource::flush_footer()
207 fseek(_fd, 0, SEEK_END);
214 SMFSource::write_footer()
216 //cerr << "SMF " << name() << " writing EOT at byte " << ftell(_fd) << endl;
219 char eot[3] = { 0xFF, 0x2F, 0x00 }; // end-of-track meta-event
220 fwrite(eot, 1, 3, _fd);
224 /** Returns the offset of the first event in the file with a time past @a start,
225 * relative to the start of the source.
227 * Returns -1 if not found.
231 SMFSource::find_first_event_after(nframes_t start)
233 // FIXME: obviously this is slooow
235 fseek(_fd, _header_size, 0);
237 while ( ! feof(_fd) ) {
238 const uint32_t delta_time = read_var_len();
240 if (delta_time > start)
248 /** Read an event from the current position in file.
250 * File position MUST be at the beginning of a delta time, or this will die very messily.
251 * ev.buffer must be of size ev.size, and large enough for the event. The returned event
252 * will have it's time field set to it's delta time, in SMF tempo-based ticks, using the
253 * rate given by ppqn() (it is the caller's responsibility to calculate a real time).
255 * \a size should be the capacity of \a buf. If it is not large enough, \a buf will
256 * be freed and a new buffer allocated in its place, the size of which will be placed
259 * Returns event length (including status byte) on success, 0 if event was
260 * skipped (eg a meta event), or -1 on EOF (or end of track).
263 SMFSource::read_event(uint32_t* delta_t, uint32_t* size, Byte** buf) const
274 *delta_t = SMFReader::read_var_len(_fd);
276 return -1; // Premature EOF
280 return -1; // Premature EOF
283 const int status = fgetc(_fd);
286 return -1; // Premature EOF
289 //printf("Status @ %X = %X\n", (unsigned)ftell(_fd) - 1, status);
291 if (status == 0xFF) {
293 return -1; // Premature EOF
295 const int type = fgetc(_fd);
296 if ((unsigned char)type == 0x2F) {
297 return -1; // hit end of track
304 const int event_size = midi_event_size((unsigned char)status) + 1;
305 if (event_size <= 0) {
310 // Make sure we have enough scratch buffer
311 if (*size < (unsigned)event_size)
312 *buf = (Byte*)realloc(*buf, event_size);
316 /*if (ev.buffer == NULL)
317 ev.buffer = (Byte*)malloc(sizeof(Byte) * ev.size);*/
319 (*buf)[0] = (unsigned char)status;
321 fread((*buf) + 1, 1, *size - 1, _fd);
323 printf("%s read event: delta = %u, size = %u, data = ", _name.c_str(), *delta_t, *size);
324 for (size_t i=0; i < *size; ++i) {
325 printf("%X ", (*buf)[i]);
332 /** All stamps in audio frames */
334 SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset) const
336 cerr << "SMF read_unlocked " << name() << " read " << start << ", count=" << cnt << ", offset=" << stamp_offset << endl;
338 // 64 bits ought to be enough for anybody
339 uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
341 _read_data_count = 0;
343 // Output parameters for read_event (which will allocate scratch in buffer as needed)
344 uint32_t ev_delta_t = 0;
345 uint32_t ev_size = 0;
348 size_t scratch_size = 0; // keep track of scratch to minimize reallocs
350 // FIXME: don't seek to start and search every read (brutal!)
351 fseek(_fd, _header_size, SEEK_SET);
353 // FIXME: assumes tempo never changes after start
354 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
355 _session.engine().frame_rate(),
356 _session.tempo_map().meter_at(_timeline_position));
358 const uint64_t start_ticks = (uint64_t)((start / frames_per_beat) * _ppqn);
361 int ret = read_event(&ev_delta_t, &ev_size, &ev_buffer);
362 if (ret == -1) { // EOF
363 //cerr << "SMF - EOF\n";
367 if (ret == 0) { // meta-event (skipped)
368 //cerr << "SMF - META\n";
369 time += ev_delta_t; // just accumulate delta time and ignore event
373 time += ev_delta_t; // accumulate delta time
375 if (time >= start_ticks) {
376 const nframes_t ev_frame_time = (nframes_t)(
377 ((time / (double)_ppqn) * frames_per_beat)) + stamp_offset;
379 if (ev_frame_time <= start + cnt)
380 dst.write(ev_frame_time, ev_size, ev_buffer);
385 _read_data_count += ev_size;
387 if (ev_size > scratch_size)
388 scratch_size = ev_size;
390 ev_size = scratch_size; // minimize realloc in read_event
396 /** All stamps in audio frames */
398 SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
400 _write_data_count = 0;
405 size_t buf_capacity = 4;
406 Byte* buf = (Byte*)malloc(buf_capacity);
408 if (_model && ! _model->writing())
409 _model->start_write();
412 bool ret = src.full_peek(sizeof(double), (Byte*)&time);
413 if (!ret || time - _timeline_position > _length + cnt)
416 ret = src.read_prefix(&time, &size);
420 if (size > buf_capacity) {
422 buf = (Byte*)realloc(buf, size);
425 ret = src.read_contents(size, buf);
427 cerr << "ERROR: Read time/size but not buffer, corrupt MIDI ring buffer" << endl;
431 assert(time >= _timeline_position);
432 time -= _timeline_position;
434 const MIDI::Event ev(time, size, buf);
435 append_event_unlocked(Frames, ev);
444 const nframes_t oldlen = _length;
445 update_length(oldlen, cnt);
447 ViewDataRangeReady (_timeline_position + oldlen, cnt); /* EMIT SIGNAL */
454 SMFSource::append_event_unlocked(EventTimeUnit unit, const MIDI::Event& ev)
456 /*printf("%s - append chan = %u, time = %lf, size = %u, data = ", _path.c_str(),
457 (unsigned)ev.channel(), ev.time(), ev.size());
458 for (size_t i=0; i < ev.size(); ++i) {
459 printf("%X ", ev.buffer()[i]);
463 assert(ev.time() >= 0);
464 assert(ev.time() >= _last_ev_time);
466 uint32_t delta_time = 0;
468 if (unit == Frames) {
469 // FIXME: assumes tempo never changes after start
470 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
471 _session.engine().frame_rate(),
472 _session.tempo_map().meter_at(_timeline_position));
474 delta_time = (uint32_t)((ev.time() - _last_ev_time) / frames_per_beat * _ppqn);
476 assert(unit == Beats);
477 delta_time = (uint32_t)((ev.time() - _last_ev_time) * _ppqn);
480 const size_t stamp_size = write_var_len(delta_time);
481 fwrite(ev.buffer(), 1, ev.size(), _fd);
483 _track_size += stamp_size + ev.size();
484 _write_data_count += ev.size();
486 _last_ev_time = ev.time();
491 SMFSource::get_state ()
493 XMLNode& root (MidiSource::get_state());
495 snprintf (buf, sizeof (buf), "0x%x", (int)_flags);
496 root.add_property ("flags", buf);
501 SMFSource::set_state (const XMLNode& node)
503 const XMLProperty* prop;
505 if (MidiSource::set_state (node)) {
509 if ((prop = node.property (X_("flags"))) != 0) {
512 sscanf (prop->value().c_str(), "0x%x", &ival);
513 _flags = Flag (ival);
521 assert(_name.find("/") == string::npos);
527 SMFSource::mark_for_remove ()
532 _flags = Flag (_flags | RemoveAtDestroy);
536 SMFSource::mark_streaming_midi_write_started (NoteMode mode, nframes_t start_frame)
538 MidiSource::mark_streaming_midi_write_started (mode, start_frame);
543 SMFSource::mark_streaming_write_completed ()
545 MidiSource::mark_streaming_write_completed();
555 Glib::Mutex::Lock lm (_lock);
558 next_peak_clear_should_notify = true;
560 if (_peaks_built || pending_peak_builds.empty()) {
562 PeaksReady (); /* EMIT SIGNAL */
568 SMFSource::mark_take (string id)
576 SMFSource::move_to_trash (const string trash_dir_name)
584 /* don't move the file across filesystems, just
585 stick it in the 'trash_dir_name' directory
586 on whichever filesystem it was already on.
589 newpath = Glib::path_get_dirname (_path);
590 newpath = Glib::path_get_dirname (newpath);
593 newpath += trash_dir_name;
595 newpath += Glib::path_get_basename (_path);
597 if (access (newpath.c_str(), F_OK) == 0) {
599 /* the new path already exists, try versioning */
601 char buf[PATH_MAX+1];
605 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
608 while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
609 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
613 if (version == 999) {
614 PBD::error << string_compose (_("there are already 1000 files with names like %1; versioning discontinued"),
623 /* it doesn't exist, or we can't read it or something */
627 if (::rename (_path.c_str(), newpath.c_str()) != 0) {
628 PBD::error << string_compose (_("cannot rename midi file source from %1 to %2 (%3)"),
629 _path, newpath, strerror (errno))
634 if (::unlink (peakpath.c_str()) != 0) {
635 PBD::error << string_compose (_("cannot remove peakfile %1 for %2 (%3)"),
636 peakpath, _path, strerror (errno))
638 /* try to back out */
639 rename (newpath.c_str(), _path.c_str());
646 /* file can not be removed twice, since the operation is not idempotent */
648 _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
654 SMFSource::safe_file_extension(const Glib::ustring& file)
656 return (file.rfind(".mid") != Glib::ustring::npos);
659 // FIXME: Merge this with audiofilesource somehow (make a generic filesource?)
661 SMFSource::find (string pathstr, bool must_exist, bool& isnew)
663 string::size_type pos;
668 /* clean up PATH:CHANNEL notation so that we are looking for the correct path */
670 if ((pos = pathstr.find_last_of (':')) == string::npos) {
673 pathstr = pathstr.substr (0, pos);
676 if (pathstr[0] != '/') {
678 /* non-absolute pathname: find pathstr in search path */
685 if (_search_path.length() == 0) {
686 PBD::error << _("FileSource: search path not set") << endmsg;
690 split (_search_path, dirs, ':');
694 for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
697 if (fullpath[fullpath.length()-1] != '/') {
702 if (access (fullpath.c_str(), R_OK) == 0) {
710 PBD::error << string_compose (_("FileSource: \"%1\" is ambigous when searching %2\n\t"), pathstr, _search_path) << endmsg;
713 } else if (cnt == 0) {
716 PBD::error << string_compose(_("Filesource: cannot find required file (%1): while searching %2"), pathstr, _search_path) << endmsg;
729 /* external files and/or very very old style sessions include full paths */
732 _name = pathstr.substr (pathstr.find_last_of ('/') + 1);
734 if (access (_path.c_str(), R_OK) != 0) {
736 /* file does not exist or we cannot read it */
739 PBD::error << string_compose(_("Filesource: cannot find required file (%1): %2"), _path, strerror (errno)) << endmsg;
743 if (errno != ENOENT) {
744 PBD::error << string_compose(_("Filesource: cannot check for existing file (%1): %2"), _path, strerror (errno)) << endmsg;
766 SMFSource::set_search_path (string p)
773 SMFSource::set_allow_remove_if_empty (bool yn)
776 _allow_remove_if_empty = yn;
781 SMFSource::set_source_name (string newname, bool destructive)
783 //Glib::Mutex::Lock lm (_lock); FIXME
784 string oldpath = _path;
785 string newpath = Session::change_midi_path_by_name (oldpath, _name, newname, destructive);
787 if (newpath.empty()) {
788 PBD::error << string_compose (_("programming error: %1"), "cannot generate a changed midi path") << endmsg;
792 if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
793 PBD::error << string_compose (_("cannot rename midi file for %1 to %2"), _name, newpath) << endmsg;
797 _name = Glib::path_get_basename (newpath);
800 return 0;//rename_peakfile (peak_path (_path));
804 SMFSource::is_empty () const
806 bool ret = (_track_size > 4);
808 //cerr << name() << " IS EMPTY: " << ret << endl;
815 SMFSource::write_chunk_header(const char id[4], uint32_t length)
817 const uint32_t length_be = GUINT32_TO_BE(length);
819 fwrite(id, 1, 4, _fd);
820 fwrite(&length_be, 4, 1, _fd);
824 SMFSource::write_chunk(const char id[4], uint32_t length, void* data)
826 write_chunk_header(id, length);
828 fwrite(data, 1, length, _fd);
831 /** Returns the size (in bytes) of the value written. */
833 SMFSource::write_var_len(uint32_t value)
837 uint32_t buffer = value & 0x7F;
839 while ( (value >>= 7) ) {
841 buffer |= ((value & 0x7F) | 0x80);
845 //printf("Writing var len byte %X\n", (unsigned char)buffer);
858 SMFSource::load_model(bool lock, bool force_reload)
864 Glib::Mutex::Lock lm (_lock);
866 if (_model && !force_reload && !_model->empty()) {
867 //cerr << _name << " NOT reloading model " << _model.get() << " (" << _model->n_notes()
868 // << " notes)" << endl;
871 cerr << _name << " loading model" << endl;
875 _model = boost::shared_ptr<MidiModel>(new MidiModel(_session));
876 cerr << _name << " loaded new model " << _model.get() << endl;
878 cerr << _name << " reloading model " << _model.get()
879 << " (" << _model->n_notes() << " notes)" <<endl;
883 _model->start_write();
885 fseek(_fd, _header_size, 0);
887 uint64_t time = 0; /* in SMF ticks */
890 size_t scratch_size = 0; // keep track of scratch and minimize reallocs
892 // FIXME: assumes tempo never changes after start
893 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
894 _session.engine().frame_rate(),
895 _session.tempo_map().meter_at(_timeline_position));
897 uint32_t delta_t = 0;
899 while ((ret = read_event(&delta_t, &ev.size(), &ev.buffer())) >= 0) {
903 if (ret > 0) { // didn't skip (meta) event
904 // make ev.time absolute time in frames
905 ev.time() = (double)time * frames_per_beat / (double)_ppqn;
910 if (ev.size() > scratch_size)
911 scratch_size = ev.size();
913 ev.size() = scratch_size;
916 _model->end_write(false);
923 SMFSource::destroy_model()
925 //cerr << _name << " destroying model " << _model.get() << endl;